List your marketing campaigns
Magicline Connect API (1.0.0)
https://connectdemo.api.magicline.com/
https://redocly.sportalliance.com/_mock/apis/magicline/connectapi/connectapi/
- Generated server url
https://connectdemo.api.magicline.com/connect/v1/contracts
- Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/connectapi/connectapi/connect/v1/contracts
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://connectdemo.api.magicline.com/connect/v1/contracts?recaptchaToken=string' \
-H 'Content-Type: application/json' \
-d '{
"customerNumber": "string",
"dateOfBirth": "2019-08-24",
"firstname": "string",
"lastname": "string"
}'- Generated server url
https://connectdemo.api.magicline.com/connect/v1/contracts/cancel
- Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/connectapi/connectapi/connect/v1/contracts/cancel
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://connectdemo.api.magicline.com/connect/v1/contracts/cancel?recaptchaToken=string' \
-H 'Content-Type: application/json' \
-d '{
"additionalInformation": "string",
"cancelationReasonId": 0,
"cancellationDate": "2019-08-24",
"cancellationDateType": "NEXT_POSSIBLE_CANCELLATION_DATE",
"cancellationType": "ORDINARY_CANCELLATION",
"confirmationEmail": "string",
"contractId": 0,
"customerNumber": "string",
"dateOfBirth": "2019-08-24",
"firstname": "string",
"lastname": "string"
}'- Generated server url
https://connectdemo.api.magicline.com/connect/v1/contracts/cancel-request
- Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/connectapi/connectapi/connect/v1/contracts/cancel-request
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://connectdemo.api.magicline.com/connect/v1/contracts/cancel-request?recaptchaToken=string' \
-H 'Content-Type: application/json' \
-d '{
"additionalInformation": "string",
"cancelationReasonId": 0,
"cancellationDate": "2019-08-24",
"cancellationDateType": "NEXT_POSSIBLE_CANCELLATION_DATE",
"cancellationType": "ORDINARY_CANCELLATION",
"confirmationEmail": "string",
"customerNumber": "string",
"dateOfBirth": "2019-08-24",
"firstname": "string",
"lastname": "string",
"studioId": 0
}'- Generated server url
https://connectdemo.api.magicline.com/connect/v1/contracts/studios/{studioId}
- Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/connectapi/connectapi/connect/v1/contracts/studios/{studioId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://connectdemo.api.magicline.com/connect/v1/contracts/studios/{studioId}'- Generated server url
https://connectdemo.api.magicline.com/connect/v1/rate-bundle
- Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/connectapi/connectapi/connect/v1/rate-bundle
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://connectdemo.api.magicline.com/connect/v1/rate-bundle?studioId=1'OK
Allowed payment types for this rate bundle. Others than in this list will not be accepted when creating a contract. Please note: The Connect API only supports 'DIRECT_DEBIT' and 'CREDIT_CARD'. Therefore, this list will contain these two values at most.
Indicates if a digital signature for the contract (and SEPA agreement) is mandatory.
Important contract details such as privacy details or special conditions. Show them to the customer before contract acceptance
An initial payment has to be made in order to gain access to the studio. An email will be sent to the user after contract creation with details how to make the payment.
The maximum value of the selectable modules that the customer can choose.
Included free modules.
Id of current data block. See name field parameter or name of Dto!
Age-based price adjustments. Price adjustments can be either a percentage by which the base price is being discounted or an absolute price.
The price for this payment frequency. Only set if "type" is either "RECURRING" or "NON_RECURRING"
The dates and respective prices on which payments are due. Only set if "type" is "MONTH_DAY"
Whether the cycle of payments repeats indefinitely. Only relevant if type is "TERM_BASED" or "MONTH_DAY".
The interval in which payments are made. Only set if "type" is "RECURRING"
The terms and respective prices after which payments are due. Only set if "type" is "TERM_BASED"
is set in combination with RECURRING type
Under development: Indicates if this RateBundle has some kind of special Payment Handling
Selectable free inclusive modules. Customer is only allowed to choose a fixed value of them. The maximum value of the selected modules describes maximumNumberOfSelectableModules property.
This contract start date of use will be used if none will be send, but can be overridden
Contains the total amount to be paid during the initial runtime of the contract and the average amounts per month and per the rate's payment frequency (e.g. 1 week)
This contract start will be used if none will be send, but can be overridden
Optional modules additionally payable.
The payment frequency of this term
Age-based price adjustments. Price adjustments can be either a percentage by which the base price is being discounted or an absolute price.
The price for this payment frequency. Only set if "type" is either "RECURRING" or "NON_RECURRING"
The dates and respective prices on which payments are due. Only set if "type" is "MONTH_DAY"
Whether the cycle of payments repeats indefinitely. Only relevant if type is "TERM_BASED" or "MONTH_DAY".
The interval in which payments are made. Only set if "type" is "RECURRING"
The terms and respective prices after which payments are due. Only set if "type" is "TERM_BASED"
A list of price adjustment rules which applies to this term. Like a 5% raise every 6 months
The new price after minimum contract duration. Null if not configured.
price for the first period of the contract, if the term has bonus period at the beginning of the contract then it is equal to 0, otherwise is equal to term price.
The new term unit after minimum contract duration. Null if not configured.
The new term value after minimum contract duration. Null if not configured.
A list of age-based price adjustments for this term. Deprecated, use "paymentFrequencyDto.ageBasedAdjustmentDtos" instead.
Deprecated, use "paymentFrequencyDto.type" instead.
Is set in combination with RECURRING type. Deprecated, use "paymentFrequencyDto.term.termUnit" instead.
Is set in combination with RECURRING type. Deprecated, use "paymentFrequencyDto.term.term" instead.
Deprecated, use "term.termUnit" instead.
Required in combination with paymentChoice DIRECT_DEBIT
Communication preferences for the customer. If specified, the list must contain an element for each message category.
Required for italian studios and none-italian nationals
Required in combination with paymentChoice CREDIT_CARD
information from an official document with identifies the customer
User will be assigned as UNISEX if no gender is set.
[Optional] Should only be set if checkout page has been called with URL param identityToken. If no customer exists with this UUID a new one will be created.
language of customer as ISO 639-1 two-letter code (e.g. es or de)
locale of customer as ISO 639-1 two-letter language and country code (e.g. es_ES or de_DE)
Only configured values in the rate bundle allowed. For Contract Voucher redemption use CASH
addition for southern Europe countries/US (e.g. Madrid, California)
If only one number is available use mobile as default.
If only one number is available use mobile as default.
Deprecated. Use the identityNumber field.
- Generated server url
https://connectdemo.api.magicline.com/connect/v1/rate-bundle
- Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/connectapi/connectapi/connect/v1/rate-bundle
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://connectdemo.api.magicline.com/connect/v1/rate-bundle \
-H 'Content-Type: application/json' \
-d '{
"contract": {
"contractSignature": {
"base64Svg": "string",
"textBlockId": 0
},
"notes": "string",
"optionalRateBundleTermModules": [
{
"id": 0
}
],
"preuseDate": "2019-08-24",
"rateBundleTermId": 0,
"selectedRateBundleModules": [
{
"id": 0
}
],
"sepaSignature": {
"base64Svg": "string",
"textBlockId": 0
},
"startDate": "2019-08-24",
"textBlockSignatures": [
{
"base64Svg": "string",
"textBlockId": 0
}
]
},
"customer": {
"additionalAddressInformation": "string",
"bankAccount": {
"accountHolder": "string",
"bic": "string",
"iban": "string"
},
"buildingName": "string",
"city": "Hamburg",
"cityPart": "string",
"communicationPreferences": [
{
"activeCommunicationChannels": [
"LETTER"
],
"messageCategoryId": 0
}
],
"countryCode": "DE",
"countryOfBirth": "UNDEFINED",
"creditCard": {
"accountPaymentInstrumentToken": "string",
"tokenizationReference": "string"
},
"dateOfBirth": "2019-08-24",
"district": "string",
"documentIdentification": {
"documentNumber": "string",
"documentType": "ID_CARD"
},
"door": "string",
"email": "string",
"firstname": "string",
"floor": "string",
"gender": "MALE",
"houseNumber": "3-4",
"identification": {
"spain_DNI_NIE": "string"
},
"identityToken": "2340b1cc-3fe7-4f81-8eca-f92181dd2bb4",
"imageObjectKey": "string",
"language": "string",
"lastname": "string",
"locale": "string",
"paymentChoice": "DIRECT_DEBIT",
"placeOfBirth": "string",
"portal": "string",
"privacyConfiguration": {
"email": true,
"letter": true,
"mySportsMessage": true,
"phone": true,
"textMessage": true
},
"province": "string",
"provinceCode": "string",
"publicGender": "MALE",
"referralCode": "string",
"secondFirstname": "string",
"secondLastName": "string",
"secondStreet": "string",
"stairway": "string",
"street": "Raboisen",
"streetBlock": "string",
"streetType": "string",
"studioCountryCode": "UNDEFINED",
"taxId": "string",
"telephone_mobile": "string",
"telephone_private": "string",
"zipCode": 22099
},
"landingPageConfigurationId": 0,
"offerUuid": "5d19bb70-d72b-45ae-9b5e-c4257877bdbb",
"studioId": 0,
"voucherCode": "string"
}'- Generated server url
https://connectdemo.api.magicline.com/connect/v2/contracts/studios
- Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/connectapi/connectapi/connect/v2/contracts/studios
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://connectdemo.api.magicline.com/connect/v2/contracts/studios