Documentația API pentru lucrul cu certificatele de plată
Tabel cu descrierile câmpurilor
| Câmp | Tip | Necesar? | Descriere |
|---|---|---|---|
| id | int | Nu | Identificatorul unic al certificatului (necesar la actualizare). |
| cod | șir | Da | Cod unic de certificat. |
| este_activ | bool | Nu | Starea activității certificatului (implicit este „adevărat”). |
| valoare | int | Nu | Valoarea nominală a certificatului. |
1. Obținerea tuturor certificatelor
Metodă: GET
URL: {domeniu}/extern/certificat-de-plată/
Descriere:
Returnează o listă cu toate certificatele de plată ale site-ului.
Exemplu de interogare:
GET {domain}/external/payment-certificate/
Exemplu de răspuns:
[
{
„id”: 1,
"cod": "CERT-001",
„este_activ”: adevărat,
„valoare”: 500
},
{
„id”: 2,
"cod": "CERT-002",
„este_activ”: fals,
„valoare”: 1000
}
]
2. Obținerea unui singur certificat
Metodă: GET
URL: {domain}/external/payment-certificate/{id}/
Descriere:
Returnează date pentru un singur certificat prin identificatorul său.
Exemplu de interogare:
GET {domain}/external/payment-certificate/1/
Exemplu de răspuns:
{
„id”: 1,
"cod": "CERT-001",
„este_activ”: adevărat,
„valoare”: 500
}
3. Reînnoirea certificatului unic
Metodă: PUT
URL: {domain}/external/payment-certificate/{id}/
Descriere:
Actualizează datele unui singur certificat prin identificatorul acestuia.
Exemplu de interogare:
PUT {domain}/external/payment-certificate/1/
Tip de conținut: application/json
Corpul cererii:
{
"code": "CERT-001-UPDATED",
„este_activ”: fals,
„valoare”: 750
}
Exemplu de răspuns:
{
„id”: 1,
"code": "CERT-001-UPDATED",
„este_activ”: fals,
„valoare”: 750
}
4. Creați mai multe certificate
Metodă: POST
URL: {domain}/external/payment-certificate/bulk-create/
Descriere:
Creează mai multe certificate în același timp.
Exemplu de interogare:
POST {domain}/external/payment-certificate/bulk-create/
Tip de conținut: application/json
Corpul cererii:
[
{
"cod": "CERT-NEW-001",
„este_activ”: adevărat,
„valoare”: 1000
},
{
"cod": "CERT-NEW-002",
„este_activ”: fals,
„valoare”: 1500
}
]
Exemplu de răspuns:
[
{
„id”: 3,
"cod": "CERT-NEW-001",
„este_activ”: adevărat,
„valoare”: 1000
},
{
„id”: 4,
"cod": "CERT-NEW-002",
„este_activ”: fals,
„valoare”: 1500
}
]
5. Actualizarea mai multor certificate
Metodă: PUT
URL: {domeniu}/extern/certificat-de-plată/actualizare-în bloc/
Descriere:
Actualizează datele mai multor certificate simultan.
Exemplu de interogare:
PUT {domain}/external/payment-certificate/bulk-update/
Tip de conținut: application/json
Corpul cererii:
[
{
„id”: 1,
"code": "CERT-001-UPDATED",
„valoare”: 800,
„este_activ”: adevărat
},
{
„id”: 2,
"code": "CERT-002-UPDATED",
„valoare”: 1200,
„este_activ”: adevărat
}
]
Exemplu de răspuns:
[
{
„id”: 1,
"code": "CERT-001-UPDATED",
„este_activ”: adevărat,
„valoare”: 800
},
{
„id”: 2,
"code": "CERT-002-UPDATED",
„este_activ”: adevărat,
„valoare”: 1200
}
]
A fost util articolul?
Da, multumesc! Din pacate nu