Composer une requête à l'API
L'API est RESTful. La forme générale d'un appel :
{VERBE} https://gateway.erpconnector.ca/api/Entity/{Entité}
| Verbe | Usage | Body |
|---|---|---|
| GET | lecture / extraction | non |
| POST | création | requis |
| PUT | mise à jour | requis |
| DELETE | suppression (peut être limité selon l'ERP) | non |
Exemples d'entités : Customer, Product, CustomerInvoice, Supplier, GLAccount...
(voir Liste des entités supportées). Un élément précis se lit avec son identifiant :
GET /api/Entity/Customer/{NoClient}.
Les modificateurs de requête (GET)
Style OData ; le premier est précédé de ?, les suivants de &.
- $select — limiter les champs retournés, séparés par des virgules :
/api/Entity/Customer?$select=NoClient,NomClientLes sous-champs sont supportés :$select=InfoAgeDesComptes.MontantDu_Cycle1_Courant. - $orderby — trier, avec
ASC(défaut) ouDESC:/api/Entity/Customer?$orderby=NoClient ASC - $top / $skip — nombre maximal d'éléments / éléments à sauter (voir Pagination).
- $expand — inclure un sous-objet ou une liste liée :
/api/Entity/GLProject?$expand=Budget01 - $filter — restreindre les résultats (voir l'article Filtres).
Combinaison
/api/Entity/Customer?$orderby=NoClient ASC&$filter=NoClient eq '01'&$top=10
Règles de syntaxe des valeurs
- Numériques : point décimal (
PrixFinal eq 12.75). - Textes et dates : entre apostrophes ; dates au format
yyyy-MM-dd(Fiche_DerniereModification gt '2024-02-10').
Pour démarrer vite
Importez la collection Postman officielle (voir l'article Collection Postman) : les entités y sont regroupées par domaine d'affaires avec des exemples prêts à exécuter.