Généralités

GLonnect.me est une plate-forme qui permet facilite la diffusion de ses données vers des partenaires externes via un modèle de données générique et des connecteurs API pré-paramétrés vers éditeurs comptables du marché. 

Le diagramme ci-dessous, présente l'architecture globale de notre solution.





Modèle de données générique

Ci-après la liste des objets accessibles via les end-point datasets/retrieve et datasets/retrieve_element

DatasetDescription
HubRefEntitiesEntité juridique (Dossier)
HubRefAccountingJournalsJournaux comptables
HubFGlDatasLignes grands livres
HubRefAccountingPeriods
Périodes comptable
HubRefGlAccounts
Comptes comptables
HubRefDocuments
Document (justificatif)
HubFRawOperationsPaiements unitaires
HubRefSourceSystems
Systèmes émetteurs
HubRefDestSystems
Systèmes récepteurs

L'envoi des données par API vers les systèmes destinataires se fait via le end-point accountigHub/push_data

Le API sont pré-paramétrées pour les éditeurs, INQOM, EVOLIZ, MyUnisoft




API Documentation

All input parameters must be passed as 'multipart/form-data'

GET
/api/1.0/oauth/get_token  (Public)

Description : 2 legged OAuth - Flow : Get an acces token. Step one is to get client_id and secret_id from our team. This is the step 2

Inputs
Attribute Required Description Set a value
api_account_id as string Y API account id
api_secret_key as string Y API secret key of your account
grant_type as string Y The value of this field should always be client_credentials
api_ttl as string N token time to live in hours. Set to 1h by default
Go to top

Returns

Default return format is : JSON

Attribute Description
expires_in as string expiration date
access_token as string token id to reuse in each call. This token will be deleted after 1H on inactivity.
return_message as string Only if error, will return a error message to explain return_code
return_code as integer Return 0 if succes else return an error code from 001 to 999. Error code will be explain in return_message

Response




GET
/api/1.0/oauth/authorization  (Public)

Description : 3 legged OAuth : (step 2/3) Get an authorization code -> Will open a form to set your credentials. Step 1 is to set the URI in the app admin panel

Inputs
Attribute Required Description Set a value
api_account_id as string Y API account id
response_type as string Y must be set to code
scope as string Y See scope list with NeoSystems
state as string Y A unique string value of your choice that is hard to guess. Used to prevent CSRF. For example, state=DCEeFWf45A53sdfKef424.
Go to top

Returns

Default return format is : JSON

Attribute Description
return_code as integer Return 0 if succes else return an error code from 001 to 999. Error code will be explain in return_message
return_message as string Only if error, will return a error message to explain return_code
code as string code to use in the acces token

Response




GET
/api/1.0/oauth/access_token  (public)

Description : 3 legged OAuth : (step 3/3) Get an access token

Inputs
Attribute Required Description Set a value
api_secret_key as string Y Since this request is made from server-side code, the secret is included
grant_type as string Y The grant type for this flow is authorization_code
code as string Y This is the code you received in the query string
redirect_uri as string Y REDIRECT_URI - Must be identical to the redirect URI provided in the original link
api_account_id as string Y CLIENT_ID - The client ID you received when you first created the application
Go to top

Returns

Default return format is : JSON

Attribute Description
return_code as integer Return 0 if succes else return an error code from 001 to 999. Error code will be explain in return_message
access_token as string token id to reuse in each call. This token will be deleted after 1H on inactivity.
expires_in as string
return_message as string Only if error, will return a error message to explain return_code

Response




GET
/api/1.0/datasets/metadata  (public)

Description : Get list of all column of a dataset

Inputs
Attribute Required Description Set a value
dataset_id as string Y Dataset id
access_token as string Y Connection token gave by connect/get_token
Go to top

Returns

Default return format is : JSON

Attribute Description
return_message as string Only if error, will return a error message to explain return_code
return_code as integer Return 0 if succes else return an error code from 001 to 999. Error code will be explain in return_message
dataset_meta_data as array All informations about dataset in an array or approriate data type. { column_name , column_type, is_foreign_key, parent_dataset }

Response




GET
/api/1.0/datasets/list  (public)

Description : Get list of all public datasets

Inputs
Attribute Required Description Set a value
access_token as string Y Connection token gave by connect/get_token
Go to top

Returns

Default return format is : JSON

Attribute Description
datasets_list as array List of all public datastes. { dataset_name , dataset_owner , dataset_description }
return_message as string Only if error, will return a error message to explain return_code
return_code as integer Return 0 if succes else return an error code from 001 to 999. Error code will be explain in return_message

Response




POST
/api/1.0/datasets/update_element  (public)

Description : Update an element identified by an eid in a dataset identified by a dataset_name and a dataset_key

Inputs
Attribute Required Description Set a value
access_token as string Y token id to reuse in each call.
attribute_values as string Y JSON string for an array of attribute names and values. for example { {"att_1","val_1"};{"att_2","val_2"}; ... ; {"att_n","val_n"} }. Use json_encode( $array) in PHP to set this zone
dataset_eid as string Y dataset element identifer
dataset_id as string Y dataset identifer
dataset_key as string Y MainKey to access dataset : Values are 'Repositoy', $user_id or custom value
Go to top

Returns

Default return format is : JSON

Attribute Description
return_message as string Only if error, will return a error message to explain return_code
return_code as integer Return 0 if succes else return an error code from 001 to 999. Error code will be explain in return_message

Response




GET
/api/1.0/datasets/retrieve  (public)

Description : Get all elements in 1 dataset

Inputs
Attribute Required Description Set a value
access_token as string Y Connection token gave by connect/get_token
query as string N substring of xquery request. like : (Name='xyz' and That='ohHoh') or (this = 'isGood')
dataset_key as string Y Main key of dataset : Value should be 'Repository' or value of an Account_Id
dataset_id as string Y dataset identifer (dataset_id) use datasets/list endpoint to get the dataset_id You can also use the dataset name, be aware that names are case sensitive.
offset as string N skips the first lines in the dataset
limit as string N Maximum number of lines returned by the call
Go to top

Returns

Default return format is : JSON

Attribute Description
return_message as string Only if error, will return a error message to explain return_code
return_code as integer Return 0 if succes else return an error code from 001 to 999. Error code will be explain in return_message
dataset as array dataset content in an array. { column_name , value }

Response




GET
/api/1.0/datasets/retrieve_element  (public)

Description : Get any datasets that is public

Inputs
Attribute Required Description Set a value
dataset_eid as string Y dataset element identifer. Identifies the line you want to retrieve in the dataset
dataset_key as string Y Main key of dataset : Value should be 'Repository' or value of an Account_Id
access_token as string Y token id to reuse in each call.
dataset_id as string Y dataset identifer
Go to top

Returns

Default return format is : JSON

Attribute Description
return_code as integer Return 0 if succes else return an error code from 001 to 999. Error code will be explain in return_message
return_message as string Only if error, will return a error message to explain return_code
dataset as array dataset content in an array. { column_name , value }

Response




POST
/api/1.0/accountigHub/update_source_data  (Restricted)

Description : Declare pushed data from a source to the accounting hub

Inputs
Attribute Required Description Set a value
access_token as string Y Connection token gave by connect/get_token
ShrdataId as string Y Id of the type of data pushed.
HubRefDocuments, Documents (Pièces justificatives)
HubFRawOperations, Détails des paiements
HubFGlDatas, Extraction du Grand Livre|
HubRefEntities, Référentiel entités (commerçants)
HubRefFirms, Référentiel des cabinets comptables
HubRefAccountingPeriods, Périodes comptables
HubUpldDataFile as file N local path to file to upload to the Hub
EntitySrcId as string Y Origine des identifiants commerçants ( INQOM, EVOLIZ, RAW) Positionner la valeur RAW si l'identifiant du commerçant (EntityId) est directement celui du système de caisse pas celui d'un système comptable
DeletePreviousFile as boolean N If DeletePreviousFile is set to '1' or 'on' , any file previously uploaded with the same name is deleted from the Hub
Period as string Y Période comptable YYYYMM
SrcsystId as string Y Système émetteur : { GENIUS,MOBIP, ADDICTILL }
EnttId as string Y Entity Id (merchand)
EnttApiKey as string N Entity API Key
Go to top

Returns

Default return format is : JSON

Attribute Description
return_message as string Only if error, will return a error message to explain return_code
return_code as integer Return 0 if succes else return an error code from 001 to 999. Error code will be explain in return_message

Response




POST
/api/1.0/accountigHub/move_data  (Restricted)

Description : Push or retrieve data from a parter

Inputs
Attribute Required Description Set a value
DstSystId as string Y System id for remote system. External partner
access_token as string Y Connection token gave by connect/get_token
Period as string Y YYYY or YYYYMM
EnttId as string Y Entity Id (merchand)
ShrdataId as string Y Id of the type of data pushed. HubRefDocuments, Documents (Pièces justificatives) HubFRawOperations, Détails des paiements HubFGlDatas, Extraction du Grand Livre| HubRefEntities, Référentiel entités (commerçants) HubRefFirms, Référentiel des cabinets comptables HubRefAccountingPeriods, Périodes comptables
ForceTransfer as string N Force transfer to destination if Data previously sent. 'true' or 'false'
ExchangeMode as string Y PUSH, RETRIEVE, UPDATE only
Debug as string N Debug mode
Go to top

Returns

Default return format is : JSON

Attribute Description
return_message as string Only if error, will return a error message to explain return_code
return_code as integer Return 0 if succes else return an error code from 001 to 999. Error code will be explain in return_message

Response



Error codes

Error code Description
0 Execution was OK
1 Invalid API Key
2 Invalid connection token
3 Connexion token expired
4 Invalid argument : Input argument does not exist
5 Invalid argument : Wrong type
6 Invalid argument : a requiered argument is missing.
7 IP not in whitelist. Please contact support team
8 Caller's IP does not match token's IP
996 No data to retrieve
997 Warning message
998 Error while processing data
999 Default generated method : This method is not implemented yet
9 Access denied, invalid grant type