API e-Cont.md este conceput pentru emiterea și gestionarea facturilor electronice pentru afaceri (B2B și B2C).
Folosind API-ul, puteți gestiona facturarea pentru diverse afaceri, importul și exportul de facturi pentru plată și multe altele.
Lista de pagini utile pentru această referință API:
- Înregistrare pe facturare.md
- Documentația pentru dezvoltatori
- Facturare.md – Sandbox
- API Endpoint – „Punct final API” (sau „punct de interacțiune” când API interacționează cu alt sistem)
Toate apelurile API trebuie efectuate către https://api.facturare.md
Avem un mediu de testare pentru testare (sandbox) disponibil la https://api.sandbox.facturare.md
Obțineți ajutor sau sugestie pentru a îmbunătăți API-ul
Am pus la dispoziție acest document în contul personal al utilizatorului.
Pentru a avea acces, trebuie să te „înregistrezi la facturare.md”.
Vă rugăm să raportați orice problemă în documentația API.
Orice solicitare de modificare a acestui document este, de asemenea, binevenită!
Dacă aveți nevoie de ajutor pentru utilizarea API-ului sau aveți nevoie să discutați despre ceva semnificativ, vă rugăm să ne trimiteți un e-mail la api.facturare.md@gmail.com.
Autentificare
API-ul folosește autentificarea de bază HTTP pentru a autentifica utilizatorii. Pentru toate solicitările este necesară o cheie API validă.
The API uses HTTP Basic Authentication to authenticate users. A valid API key is required for all requests.
Utilizați numai solicitări HTTPS! Orice solicitări HTTP vor fi ignorate.
Obținerea unei chei API
O cheie API poate fi obținută conectându-vă la facturare.md și selectând „Setări → Dezvoltatori → Chei API”.
Fiecare companie de pe facturare.md are propriul set de chei API.
Vă recomandăm să creați o cheie API separată pentru fiecare aplicație care va efectua apeluri în numele dvs.
Errors
Each API call returns an HTTP status code that reflects the nature of the response. We have done our best to follow the HTTP status code conventions.
The facturare.md API returns the following HTTP status codes:
200 OK – Request succeeded
201 Created – A resource was created
204 No Content – Request succeeded but there is no response body
400 Bad Request – Invalid request parameters
401 Unauthorized – Incorrect or missing API key
403 Forbidden – You do not have permission to view a resource or perform an action
404 Not Found – The specified resource could not be found
429 Too Many Requests – You’re moving too fast! Slow down!
500 Internal Server Error – There was a problem on our end
Any request that did not succeed will return a 4xx or 5xx error. The 4xx range means there was a problem with the request, like a missing parameter. The 5xx range means that something went wrong on our end.
All error responses will contain an object with these attributes
PARAMETER DESCRIPTION
type Type of error, invalid_request or api
message Explanation of the error
param Available when a specific request parameter was responsible
Versioning
Any future changes to the API will be versioned in order to maintain backwards compatibility with existing integrations.
Special Parameters
Expanding Relations
Usually you need to request more than just an invoice. Often, you might want data about the associated customer. There is a built-in way to do this that saves extra API requests.
curl „https://api.facturare.md/invoices/:id?expand=customer” \
-u {API_KEY}:
Certain relational properties can be expanded by passing in a comma-separated list of properties to expand through the expand parameter. For example if you were requesting a payment and wanted to expand the associated customer and invoice objects you would set expand=customer,invoice. This will replace the ID on the customer and invoice properties with expanded objects.
The expand parameter works for any response that has relational properties.
Filter
The filter parameter allows you to search entities based on an exact match. While it is not meant to replace a search API, the filter parameter can be useful if you need to look up a customer by name or want to list all overdue invoices. It can be used on many of the list endpoints.
The filter parameter is an object whose keys are the properties that should be matched.
Example retrieving a list of outstanding invoices for a customer:
curl „https://api.facturare.md/invoices?filter%5Bpaid%5D=0&filter%5Bclosed%5D=0&filter%5Bcustomer%5D=1234” \
-u {API_KEY}:
Metadata Filter
The metadata parameter behaves in a similar fashion to the filter parameter. It allows you to search entities that have an exactly matching metadata value for each constraint given. It can be used on any of the list endpoints for objects that support metadata.
The metadata parameter is an object whose keys should exactly match the metadata of the objects returned. If an object does not have a metadata value for a given key then the object will not be included in the result set, with no error being thrown.
Example retrieving customers with a matching account-rep metadata value:
curl „https://api.facturare.md/customers?metadata%5Baccount-rep%5D=Jan” \
-u {API_KEY}:
