Reference

This is a flat view of all the representations and relations. If you would rather explore our API starting from the Entry Point, please use the Browser.

Quick reminder:
  • Representation: a set of name-value pairs representing the state of a resource.
  • Relation: the identifier of a link between two resources.

apps

  1. app-representation
  2. apps-representation
  3. get-app
  4. get-apps
  5. patch-app
  6. search-app-by-id

1. app-representation

Description: An app representation. And app holds configuration for a single REST client.

Properties
id
The app id. Constraints: 36 characters or less, Read-Only.
name
The app name. It is is given by SlimPay. Constraints: Text, 24 characters or less, Read-Only.
secret
The app secret, generated by SlimPay, can be regenerated with a patch. Constraints: Text, 40 characters or less,Read-Write.
notifyUrl
The URL where notifications should be sent if needed. Text, 255 characters or less, Read-Write.
returnUrl
The URL where the end-user should be returned when the process completes. Constraints: Text, 255 characters or less, Read-Write.
Example: A app representation
{
    "id": "6768adac-2a8b-11e7-94bf-000000000001",
    "name": "democreditor01",
    "notifyUrl": "",
    "returnUrl": "https://dev.slimpay.com/hapi/browser",
    "secret": "",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/apps/6768adac-2a8b-11e7-94bf-000000000001"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/apps"
        },
        "https://api.slimpay.net/alps#patch-app": {
            "href": "https://api.preprod.slimpay.com/apps/6768adac-2a8b-11e7-94bf-000000000001"
        }
    }
}

2. apps-representation

Description: A collection of apps.

3. get-app (relation)

Description: Get one app.

Properties

No dynamic property needed. This usually means that the server already took the liberty to build the full URL for you depending on the context. Less code for you!

4. get-apps (relation)

Description: Get a collection of apps.

Properties

No dynamic property needed. This usually means that the server already took the liberty to build the full URL for you depending on the context. Less code for you!

Example: Search one app by id
Request
GET follow(https://api.slimpay.net/alps#get-apps) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGlfYWRtaW4iXSwiZXhwIjoxNTMwNjMzNjM5LCJqdGkiOiIxZTViNmM3OC1hZGI2LTRmN2MtOWFjZi0zOTU2MGY0ODhlMWEiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3Ijcm9kb2xwaGUucm9jY2FAc2xpbXBheS5jb20ifQ.teIzLa2RlP0-sseqoTQg6m31A2sIlphqZH7PUmcglV4
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 768

{
    "_embedded": {
        "apps": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/apps/6768adac-2a8b-11e7-94bf-000000000001"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/apps"
                    },
                    "https://api.slimpay.net/alps#patch-app": {
                        "href": "https://api.preprod.slimpay.com/apps/6768adac-2a8b-11e7-94bf-000000000001"
                    }
                },
                "id": "6768adac-2a8b-11e7-94bf-000000000001",
                "notifyUrl": "",
                "name": "democreditor01",
                "secret": "",
                "returnUrl": "https://dev.slimpay.com/hapi/browser"
            }
        ]
    },
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/creditors/democreditor/apps"
        }
    }
}

5. patch-app (relation)

Description: Patch an app. Only notifyUrl and returnUrl can be updated directly. A new secret is generated if the given secret value is set to "generate", in which case the secret is returned only once when the patch returns (a subsequent get will not return the secret).

Properties
secret
The app secret, generated by SlimPay, can be regenerated with a patch. Constraints: Text, 40 characters or less,Read-Write.
notifyUrl
The URL where notifications should be sent if needed. Text, 255 characters or less, Read-Write.
returnUrl
The URL where the end-user should be returned when the process completes. Constraints: Text, 255 characters or less, Read-Write.
Example: Patch one app
Request
PATCH follow(https://api.slimpay.net/alps#patch-app) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Content-Type: application/merge-patch+json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGlfYWRtaW4iXSwiZXhwIjoxNTMwNjMzNjM5LCJqdGkiOiIxZTViNmM3OC1hZGI2LTRmN2MtOWFjZi0zOTU2MGY0ODhlMWEiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3Ijcm9kb2xwaGUucm9jY2FAc2xpbXBheS5jb20ifQ.teIzLa2RlP0-sseqoTQg6m31A2sIlphqZH7PUmcglV4

{
    "notifyUrl": null,
    "returnUrl": "https://dev.slimpay.com/hapi/browser"
}
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 375

{
    "id": "6768adac-2a8b-11e7-94bf-000000000001",
    "name": "democreditor01",
    "notifyUrl": "",
    "returnUrl": "https://dev.slimpay.com/hapi/browser",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/apps/6768adac-2a8b-11e7-94bf-000000000001"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/apps"
        }
    }
}

6. search-app-by-id (relation)

Description: Search one app by id.

Properties
id
The app id. Constraints: 36 characters or less, Read-Only.