API docs by Redocly

Aptic API Gateway - Custom services (v1.0)

Download OpenAPI specification:Download

Aptic AB: api@aptic.net URL: https://www.aptic.net Terms of Service

Custom services related API for Aptic solutions

Callback

Invokes a named callback. The callback can contain optional query arguments and authorization might be optional.

Authorizations:
(oauth2apikey)
path Parameters
callbackName
required
string

Name of the service definition for the callback

Responses

Response samples

Content type
No sample

Invokes a named callback. The callback can contain optional query arguments and authorization might be optional.

Authorizations:
(oauth2apikey)
path Parameters
callbackName
required
string

Name of the service definition for the callback

Request Body schema:

Any custom defined input

any

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }

Services

Invokes a custom action based on a service definition. The url can also be extended with sub-paths.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

Name of the service definition to invoke

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Responses

Response samples

Content type
{ }

Invokes a custom action based on a service definition.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

Name of the service definition to invoke

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

Any JSON input

any

Responses

Request samples

Content type
null

Response samples

Content type
{ }

Invokes a custom action based on a service definition.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

Name of the service definition to invoke

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

Any JSON input

any

Responses

Request samples

Content type
null

Response samples

Content type
{ }

Invokes a custom action based on a service definition.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

Name of the service definition to invoke

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

Any JSON input

any

Responses

Request samples

Content type
null

Response samples

Content type
{ }

Invokes a custom action based on a service definition.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

Name of the service definition to invoke

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

Any JSON input

any

Responses

Request samples

Content type
null

Response samples

Content type
{ }

Get identity using filters

Authorizations:
(oauth2apikey)
query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }

Webhooks

Get all my webhooks

It's only the webhooks registered by current authenticated user/clientid that is returned.

        Any secret provided at registration will not be returned for security reasons.

You cannot provide any parameters to this API

How to use the API

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{
  • "count": 0,
  • "webHooks": [
    ]
}

Register a webhook to listen to specified events.

It's possible to register multiple events to listen for, in the same API call.

        Some events, like `transaction` will have a performance hit on the service.

Multiple events can be specified in the same API call.

        Event examples:

        appsrvstartup, appsrvpause, appsrvshutdown, procsrvstartup, procsrvpause, procsrvshutdown

        refreshcache, setserverdate

        userlogin, userlogout, userloginfailed

        jobcomplete, jobfailed

        logfileinsert, activityloginsert

        accountinsert, accountupdate, accountclose, accountrevoke, accountdelete

        debtinsert, debtupdate, debtdelete

        payment, disbursement

        debtorinsert, debtorupdate, debtordelete, debtoridnumberchange, debtornamechange, debtoraddresschange, debtormerge

        customerinsert, customerupdate, customeraddresschange

        partydeleted, partyblocked, partyunblocked, partyinsert

        transaction

        extrafieldinsert, extrafieldupdate, extrafielddelete

        ledgerrespiteinsert, ledgerrespitedelete

        collectionrespiteinsert, collectionrespitedelete

        userinsert, userupdate, userdelete

        paymentplanactivated, paymentplandeactivated, paymentplanbroken, paymentplanfinished

        letterprocessed, actionperformed, linkprocesscompleted

        creditdebtinsert, creditdebtupdate, creditdebtdelete

        cardinsert, cardupdate, carddelete

        creditdebtpledgeinsert, creditdebtpledgeupdate, creditdebtpledgedelete

        campaigninsert, campaignupdate, campaigndelete

        approvedjournal

        creditdebtinsurancenew, creditdebtinsuranceupdate, creditdebtinsurancestatuschanged

        conversationduedatepass, notificationduedatepass, conversationinsert, conversationnewmessage, conversationclosure, conversationreplied

        partyparamupdated

        ledgerpayment

        newcreditorfee, newcreditorhistorynote

        defray, statuschange

        purchase, recourse

        creditdebtserviceinsert, creditdebtserviceactivate, creditdebtserviceupdate, creditdebtservicedelete

How to use the API

Authorizations:
(oauth2apikey)
Request Body schema:

WebHook specification

events
Array of strings or null

Webhook events to subscribe to. Examples:

url
string or null

Complete URL including protocol and optional query arguments

secret
string or null

Secret that will be returned in the webhook POST response

method
string or null

The method to be used by the webhook. POST is default

Responses

Request samples

Content type
{
  • "events": [
    ],
  • "url": "string",
  • "secret": "string",
  • "method": "string"
}

Response samples

Content type
{
  • "events": [
    ],
  • "url": "string",
  • "method": "string"
}

Unregister a webhook from listen to specified/all events.

How to use the API

Authorizations:
(oauth2apikey)
Request Body schema:

WebHook specification

url
string or null

Complete URL including protocol and optional query arguments of the webhook to delete

events
Array of strings or null

Delete Webhook for specified events. All events will be deleted if omitted.

Responses

Request samples

Content type
{
  • "url": "string",
  • "events": [
    ]
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }