API e-Cont.md прендназначен для выставления и оборота электронных счетов на оплату для бизнеса (B2B и B2C).
С помощью API вы можете управлять выставлением счетов для различных бизнесов, импортом и экспортом счетов на оплату и многим другим.
Перечень полезных страниц по данному справочнику по API:
- Регистрация на facturare.md
- Документация для разработчиков
- Facturare.md — Песочница
- API Endpoint — «Конечная точка API» (или «точка взаимодействия», когда API взаимодействует с другой системой)
Все вызовы API должны быть сделаны на https://api.facturare.md
У нас есть тестовая среда для тестирования (песочница), доступная по адресу https://api.sandbox.facturare.md
Получение помощи или предложения по улучшению API
Мы сделали этот документ доступным в личном кабинете пользователя.
Для того, чтобы у вас был доступ, вам необходимо «зарегистрироваться в facturare.md».
Пожалуйста, сообщайте о любых проблемах в документации по API.
Любые запросы на внесение изменений в этот документ также приветствуются!
Если вам нужна помощь в использовании API или вам нужно обсудить что-то значимое, напишите нам по адресу api.facturare.md@gmail.com.
Аутентификация
API использует базовую аутентификацию HTTP для аутентификации пользователей. Действительный ключ API требуется для всех запросов.
Используйте только HTTPS запросы! Любые HTTP-запросы будут игнорироваться.
Получение ключа API
Ключ API можно получить, войдя на facturare.md и выбрав «Настройки → Разработчики → Ключи API».
У каждой компании на facturare.md есть свой набор ключей API.
Мы рекомендуем создать отдельный ключ API для каждого приложения, которое будет совершать запросы от вашего имени.
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}:
Authorisation Details:
— Access Token:
— Refresh Token:
— Redirect URI:
— YOUR_APP_CLIENT_ID:
— YOUR_AUTHORIZATION_CODE:
— YOUR_APP_CLIENT_SECRET:
— YOUR_APP_HTTPS_REDIRECT_URI:
