hiDocs

HiAPI basics

• Requests are sent over https://api-domain/commandName
  • commandName is usually: objectAction or objectsAction
  • e.g. clientsSearch, contactUpdate
• Request data can be passed via GET or POST variables
• The results of the request are returned encoded in JSON
• In case of an error there will be _error element in a returned array. This key will contain the description of the error
• Acceptable request results may be:
  • scalar true
  • an array which does not contain _error element
  • any other result including the blank is an error

HiAPI Search

• Usually search commands are created like

    POST http://{api.domain.com}/{entity}sSearch?field1=value1&field2=value2&orderby=field1_asc
  

{entity} examples: object, client, etc

• All filter fields are described in Swagger
• To display a count of result objects add to query param count=1.
• Order By
  • to order search result use orderby param
  • order value usually looks like <field_name>_<asc or desc>
  • For every command order fields are individual. For more information you should ask tech support.
  • Also in general case you can order by only one field.

HiAPI reference

In different modules (client, server, etc) all objects has their properties and types. Usually thay are cashed in admin page, but you can take it with API by /refsSearch endpoint.

• Run request:

   POST https://{api.domain.com}/refsSearch?gtype=state,client
  

• For detailed info about gtypes ask tech support.

• Also look detailed info in Swagger for refsSearch command.

Create authorized request

To create authorized request to API you need to get a authorization token. In general case of API usage, user can take it from OAuth2 server. But there is a functionality to get it via OAuth2 Tokens API.

Authorization token can be sent via:

- `access_token` GET or POST variable
- `Authorization: Bearer` HTTP header

Example:

POST https://api-domain/objectsSearch
Authorization: Bearer s45sdfsdf3425fg25sdfadg23452dfs35
name_like=somename

POST https://api-domain/objectsSearch?access_token=s45sdfsdf3425fg25sdfadg23452dfs35&name_like=somename