Aktywacja API
API pozwala na zdalne wykonywanie operacji na koncie w cal.pl takich jak sprawdzanie dostępności domen, rejestracja domen, transfer domen oraz odnawianie domen. API zostanie rozbudowane o możliwość działania na serwerach
współdzielonych oraz VPS.
API polega na wysyłaniu żądań zgodnych z dokumentacją na adres https://www.cal.pl/soapi/{OPERATION}.
API zwraca wartości zawsze w formacie JSON.
W celu uzyskania połączenia z API należy wygenerować klucze w panelu centrum klienta na stronie centrum.cal.pl. Podczas generowania kluczy połączeniowych warto zaznaczyć adresy IP dla których
połączenie będzie możliwe.
Po aktywacji API w panelu centrum klienta dostępne będą:
API Key
API CODE
Oba te klucze służą do autoryzacji połączenia.
Połączenie z API
W celu uzyskania połączenia z API należy wysłać żądanie z parametrami POST:
https://www.cal.pl/soapi/
Poniższe parametry są zawsze wymagane dla każdego typu operacji wykonywanych przez API.
WYMAGANE PARAMETRY
| Parametr |
Typ |
Opis |
| api_key |
String |
Twój API_KEY autoryzujący. |
| api_code |
String |
Twój API_CODE autoryzujący |
Funkcja HELLO
W celu sprawdzenia poprawności połączenia można wysłać żądanie hello:
https://www.cal.pl/soapi/hello
WYMAGANE PARAMETRY
| Parametr |
Typ |
Opis |
| api_key |
String |
Twój API_KEY autoryzujący. |
| api_code |
String |
Twój API_CODE autoryzujący |
PRZYKŁADOWA ODPOWIEDŹ
| Parametr |
Typ |
Opis |
| code |
Integer |
200 (połączenie prawidłowe) |
| version |
String |
Aktualna wersja API |
Funkcja BALANCE
W celu sprawdzenia stanu doładowania konta:
https://www.cal.pl/soapi/balance
WYMAGANE PARAMETRY
| Parametr |
Typ |
Opis |
| api_key |
String |
Twój API_KEY autoryzujący. |
| api_code |
String |
Twój API_CODE autoryzujący |
PRZYKŁADOWA ODPOWIEDŹ
| Parametr |
Typ |
Opis |
| code |
Integer |
200 (połączenie prawidłowe) |
| command |
String |
status komendy (success) |
| summary |
bool |
stan konta |
| currency |
String |
skrót obsługiwanej waluty, null lub PLN dla zł |
| monitoring |
String |
ustawiona kwota monitoringu salda lub null w przypadku braku |
Funkcja DOMAINS-CHECK
W celu sprawdzenia dostępności domeny:
https://www.cal.pl/soapi/domains-check
WYMAGANE PARAMETRY
| Parametr |
Typ |
Opis |
| api_key |
String |
Twój API_KEY autoryzujący. |
| api_code |
String |
Twój API_CODE autoryzujący |
| domain |
String |
nazwa domeny do sprawdzenia |
PRZYKŁADOWA ODPOWIEDŹ
| Parametr |
Typ |
Opis |
| code |
Integer |
200 (połączenie prawidłowe) |
| command |
String |
status komendy (success) |
| domain |
string |
Nazwa domeny |
| status |
String |
free dla wolnej, taken dla zajętej |
| price |
String |
cena rejestracji domeny |
Funkcja DOMAINS-LIST
Lista domen na profilu centrum klienta:
https://www.cal.pl/soapi/domains-list
WYMAGANE PARAMETRY
| Parametr |
Typ |
Opis |
| api_code |
String |
Twój API_CODE autoryzujący |
| api_key |
String |
Twój API_KEY autoryzujący. |
PRZYKŁADOWA ODPOWIEDŹ
| Parametr |
Typ |
Opis |
| code |
Integer |
200 (połączenie prawidłowe) |
| command |
String |
status komendy (success) |
| domains |
int |
ilość domen na profilu |
| details |
String |
szczegóły domen takie nazwa domeny, data wygaśnięcia, podłączone konto, aktywne przekierowane itp. |
Funkcja DOMAINS-DNS
Lista pozwala na pobranie DNS domen:
https://www.cal.pl/soapi/domains-dns
WYMAGANE PARAMETRY
| Parametr |
Typ |
Opis |
| api_code |
String |
Twój API_CODE autoryzujący |
| api_key |
String |
Twój API_KEY autoryzujący. |
| domain |
String |
nazwa domeny. |
PRZYKŁADOWA ODPOWIEDŹ
| Parametr |
Typ |
Opis |
| code |
Integer |
200 (połączenie prawidłowe) |
| command |
String |
status komendy (success) |
| domain |
String |
Nazwa domeny |
| dns |
Array |
Lista serwerów DNS |
Funkcja DOMAINS-DNS-EDIT
Lista pozwala na zmianę DNS domen:
https://www.cal.pl/soapi/domains-dns-edit
WYMAGANE PARAMETRY
| Parametr |
Typ |
Opis |
| api_code |
String |
Twój API_CODE autoryzujący |
| api_key |
String |
Twój API_KEY autoryzujący. |
| domain |
String |
nazwa domeny. |
| dns |
String |
nazwa serwera DNS. |
| option |
String |
opcja add (dodanie dns), opcja del (usunięcie dns). |
PRZYKŁADOWA ODPOWIEDŹ
| Parametr |
Typ |
Opis |
| code |
Integer |
200 (połączenie prawidłowe) |
| command |
String |
status komendy (success) |
Funkcja OPERATIONS
Lista pozwala pobranie wszystkich operacji na koncie partnerskim:
https://www.cal.pl/soapi/operations
WYMAGANE PARAMETRY
| Parametr |
Typ |
Opis |
| api_code |
String |
Twój API_CODE autoryzujący |
| api_key |
String |
Twój API_KEY autoryzujący. |
PRZYKŁADOWA ODPOWIEDŹ
| Parametr |
Typ |
Opis |
| code |
Integer |
200 (połączenie prawidłowe) |
| command |
String |
status komendy (success) |
| history |
Json |
historia operacji na koncie |
Funkcja DOMAIN-TRANSFER
Funkcja pozwala na transfer domeny
https://www.cal.pl/soapi/domains-transfer
WYMAGANE PARAMETRY
| Parametr |
Typ |
Opis |
| api_code |
String |
Twój API_CODE autoryzujący |
| api_key |
String |
Twój API_KEY autoryzujący. |
| domain |
String |
Nazwa domeny do transferu. |
| authcode |
String |
Kod autryzacyjny. |
PRZYKŁADOWA ODPOWIEDŹ
| Parametr |
Typ |
Opis |
| code |
Integer |
200 (połączenie prawidłowe) |
| command |
String |
status komendy (success) |
Funkcja contacts
W zależności od operacji, tworzy tablicę z niezbędnymi danymi i wywołuje funkcję soapi do przetworzenia danych.
https://www.cal.pl/soapi/contacts
Parametry funkcji
| Parametr |
Typ |
Opis |
| api_code |
String |
Twój API_CODE autoryzujący. |
| api_key |
String |
Twój API_KEY autoryzujący. |
Przykładowa odpowiedź
| Parametr |
Typ |
Opis |
| code |
Integer |
200 (połączenie prawidłowe) |
|
|
500 (brak autoryzacji) |
| command |
String |
Status komendy (success) |
| contacts |
Array |
Lista kontaktów zawierająca takie informacje jak nazwa, adres, miasto, kod pocztowy, nip, telefon, email. |
Funkcja contacts-create
Funkcja pozwala na utworzenie nowego kontaktu w systemie.
https://www.cal.pl/soapi/contacts-create
Parametry funkcji
| Parametr |
Typ |
Opis |
| api_code |
String |
Twój API_CODE autoryzujący. |
| api_key |
String |
Twój API_KEY autoryzujący. |
| name |
String |
Imie i nazwisko lub nazwa kontaktu. |
| address |
String |
Adres kontaktu. |
| zipcode |
String |
Kod pocztowy kontaktu. |
| city |
String |
Miasto kontaktu. |
| nip |
String |
Numer nip kontaktu. |
| phone |
String |
Numer telefonu kontaktu. |
| email |
String |
Numer telefonu kontaktu. |
Przykładowa odpowiedź
| Parametr |
Typ |
Opis |
| code |
Integer |
200 (połączenie prawidłowe) |
|
|
500 (brak autoryzacji) |
| command |
String |
Status komendy (success) |
| details |
String |
Szczegóły kontaktu takie jak nazwa, adres, miasto, kod pocztowy, nip, telefon, email. |
Funkcja contacts-details
Funkcja pozwala na uzyskanie szczegółowych informacji o kontakcie.
https://www.cal.pl/soapi/contacts-details
Parametry funkcji
| Parametr |
Typ |
Opis |
| api_code |
String |
Twój API_CODE autoryzujący. |
| api_key |
String |
Twój API_KEY autoryzujący. |
| cl |
String |
Identyfikator klienta. |
Przykładowa odpowiedź
| Parametr |
Typ |
Opis |
| code |
Integer |
200 (połączenie prawidłowe) |
|
|
500 (brak autoryzacji) |
| command |
String |
Status komendy (success) |
| details |
String |
Szczegóły kontaktu takie jak nazwa, adres, miasto, kod pocztowy, nip, telefon, email. |
Funkcja domain-register
Funkcja umożliwia rejestrację nowej domeny internetowej.
https://www.cal.pl/soapi/domain-register
Parametry funkcji
| Parametr |
Typ |
Opis |
| api_code |
String |
Twój API_CODE autoryzujący. |
| api_key |
String |
Twój API_KEY autoryzujący. |
| domain |
String |
Nazwa domeny do zarejestrowania. |
| contact |
String |
Identyfikator kontaktu. |
Przykładowa odpowiedź
| Parametr |
Typ |
Opis |
| code |
Integer |
200 (połączenie prawidłowe) |
|
|
500 (brak autoryzacji) |
|
|
250 (brak środków na koncie) |
|
|
550 (wewnętrzny błąd, skontaktuj się z pomocą techniczną) |
|
|
560 (problem z rejestracją domeny) |
| command |
String |
Status komendy (success, problem z rejestracją domeny, wewnętrzny błąd, brak autoryzacji, brak środków na koncie) |
| domain |
String |
Nazwa zarejestrowanej domeny. |
| price |
Float |
Koszt rejestracji domeny. |
| contact |
String |
Identyfikator kontaktu użytego do rejestracji. |
Funkcja domain-renew
Funkcja pozwala na odnowienie wybranej domeny internetowej na okres 1 roku.
https://www.cal.pl/soapi/domain-renew
Wymagane parametry
| Parametr |
Typ |
Opis |
| api_code |
String |
Twój API_CODE autoryzujący |
| api_key |
String |
Twój API_KEY autoryzujący. |
| domain |
String |
nazwa domeny do odnowienia |
PRZYKŁADOWA ODPOWIEDŹ
| Parametr |
Typ |
Opis |
| code |
Integer |
200 (połączenie prawidłowe)
500 (brak autoryzacji )
250 (brak środków na koncie) |
| command |
String |
status komendy (success) |
| domains |
int |
ilość domen na profilu |
| details |
String |
szczegóły domen takie nazwa domeny, data wygaśnięcia, podłączone konto, aktywne przekierowane itp. |
Funkcja future-list
Funkcja pozwala na uzyskanie listy przyszłych operacji związanych z domenami.
https://www.cal.pl/soapi/future-list
Parametry funkcji
| Parametr |
Typ |
Opis |
| api_code |
String |
Twój API_CODE autoryzujący. |
| api_key |
String |
Twój API_KEY autoryzujący. |
Przykładowa odpowiedź
| Parametr |
Typ |
Opis |
| code |
Integer |
200 (połączenie prawidłowe) |
|
|
500 (brak autoryzacji) |
| command |
String |
Status komendy (success) |
| futures |
Array |
Lista przyszłych operacji dotyczących domen, w tym: |
|
|
- id: unikalny identyfikator operacji |
|
|
- domain: nazwa domeny |
|
|
- action: planowana akcja (np. rejestracja, odnowienie) |
|
|
- date: data planowanej operacji |
Funkcja future-check
Funkcja pozwala na sprawdzenie dostępności przyszłych domen.
https://www.cal.pl/soapi/future-check
Parametry funkcji
| Parametr |
Typ |
Opis |
| api_code |
String |
Twój API_CODE autoryzujący. |
| api_key |
String |
Twój API_KEY autoryzujący. |
| domain |
String |
Nazwa domeny do sprawdzenia. |
Przykładowa odpowiedź
| Parametr |
Typ |
Opis |
| code |
Integer |
200 (połączenie prawidłowe) |
|
|
500 (brak autoryzacji) |
| command |
String |
Status komendy (np. domain check) |
| status |
String |
'available' lub 'taken' |
| price |
Float |
cena domeny (jeśli dostępna) |
Funkcja future-register
Funkcja umożliwia rejestrację domen, które będą dostępne w przyszłości.
https://www.cal.pl/soapi/future-register
Parametry funkcji
| Parametr |
Typ |
Opis |
| api_code |
String |
Twój API_CODE autoryzujący. |
| api_key |
String |
Twój API_KEY autoryzujący. |
| domain |
String |
nazwa domeny do rejestracji. |
| confirm |
String |
potwierdzenie operacji ('yes'). |
Przykładowa odpowiedź
| Parametr |
Typ |
Opis |
| code |
Integer |
200 (połączenie prawidłowe) |
|
|
500 (brak autoryzacji) |
| command |
String |
status komendy (np. future register) |
| status |
String |
status rejestracji (np. 'success' lub 'error') |
| domain |
String |
Zarejestrowana domena lub informacja o błędzie. |
