API Overview

API Overview

Summary

This document details how to connect to the Argos Web API.

The following document describes:
  1. The parties     
  2. The prerequisites for connecting to the Argos Web API.
  3. Authenticating with the Argos Web API
  4. The available API specifications

Available APIs

A list of available APIs can be found here

Intended Audience 

The intended audience for this document are developers or technical personnel wishing to connect to the Argos Web API. A level of familiarity with programming, REST and web technology is assumed

The Parties

Argos Financial Systems

Provides the Web API software, and technical support

The Argos Client

Owns the data and provides hosting for the web API software

Third Party Developer

Anyone wishing to connect and make requests to the web API operated by the Argos Client

Document Conversions

Code

Any code examples (URLs, etc) will be presented in a fixed width font

User Supplied Data

User supplied data within a code example (ids, etc) will be presented in italic fixed width font and surrounded by curly braces, e.g. {id}.

Prerequisites

Authorisation

Authenticated requests are made with a username and password. This should be set up for each user of the third-party application that will connect to the web API. The Argos Client is responsible for setup and maintenance of the external users.

Each session must be authorised using an external username and password.

These will be setup and maintained by the Argos Client.

Authenticating will return a token for use in the other requests. This token will expire 24 hours after creation

Sample Request

Notes
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d
'grant_type=password&username=<user>&password=<password>' "
https://api.argos.co.nz/WebApi/token"

Sample Response

Notes
{
"access_token": "<token-string>",                                                                     
"token_type": "bearer",
"expires_in": 86399
}

Making a Request

Each request must be authenticated. The content of the request should be in JSON format.

Content type

The request will require a content type header in the format

      Content-Type: application/json

Authorisation Token

The request will require an authorisation header in the format

Bearer <token-string>

Where <token-string> is the token obtained from the authorisation request.

API Format

The API uses a REST format. Each request corresponds to a separate URL.

Responses are in JSON format.

Response Codes

Standard REST HTTP response codes are used. A code of 200 indicates the request was processed. Note: a response code of 200 does not mean the request succeeded, only that is was processed.



    • Related Articles

    • Dispatch Centre Configuration - Microsoft Graph

      Purpose Microsoft is moving away from SMTP. Their lastest technology to send email uses Microsoft Graph with Modern Authentication. In order to send email through Microsoft Graph you will need to setup a Microsoft Azure Entra Id application in a ...

    • Update Client API

      Description Update the details of a specific client Security Logged in user has client API permissions URL PATCH http://exampleserver.com/api/v3/Clients/{client_id} Parameters Model Field Type Description actualAddress String (optional) The client's ...

    • Create Client API

      Description Add a new client Security Logged in user has client API permissions URL POST http://example.com/api/clients/createClient Parameters TBC Response Create Client Request Field Type Description code String The client code name String The ...

    • Get All Clients API

      Description Get a list of all clients in the system Security Logged in user has client API permissions URL GET http://exampleserver.com/api/v6/clients?clientCode={clientCode}&clientName={clientName}&activeOnly={false}&groupCode={groupCode} Parameters ...

    • Update Account API

      Description Update the details of a specific account. Security Logged in user has account API permissions URL PATCH http://exampleserver.com/api/v3/Accounts/{account_id} Parameters Model Field Type Description description String (optional) The ...