apps — Web API Reference

1. app-representation

Description: A representation of an app resource. An app holds the configuration for a single REST client.

Properties

id: The app id, allocated by SlimPay. Constraints: 36 characters or less, Read-Only.
name: The app name, allocated by SlimPay. Constraints: Text, 24 characters or less, Read-Only.
secret: The app secret, allocated by SlimPay for merchant authentication. An app secret can be regenerated by following the patch-app relation. Constraints: Text, 40 characters or less, Read-Write.
notifyUrl: A URL configured by the merchant notifying them of the status of a Checkout transaction (completed or abandoned). Text, 255 characters or less, Read-Write (optional).
returnUrl: Configured by the merchant, this is the URL of the webpage a customer is redirected to following the completion of a Checkout transaction. Constraints: Text, 255 characters or less, Read-Write (optional).

Example: An 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 app representations, each holding the configuration for a single REST client.

3. get-app (relation)

Description: Retrieve the representation of a single app resource.

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: Retrieve the representations of a collection of app resources. These will be returned in descending order.

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: Retrieve a collection of app representations

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 resource. The notifyUrl and returnUrl properties can be updated directly, while a new secret can be generated if the given secret value is set to "generate". In that case, the new secret is returned only once when the patch returns (any subsequent get-app request will not return the secret).

Properties

secret: The app secret, allocated by SlimPay for merchant authentication. An app secret can be regenerated by following the patch-app relation. Constraints: Text, 40 characters or less, Read-Write.
notifyUrl: A URL configured by the merchant notifying them of the status of a Checkout transaction (completed or abandoned). Text, 255 characters or less, Read-Write (optional).
returnUrl: Configured by the merchant, this is the URL of the webpage a customer is redirected to following the completion of a Checkout transaction. Constraints: Text, 255 characters or less, Read-Write (optional).

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 for the representation of a specific app resource, using its id parameter.

Properties

id: The app id, allocated by SlimPay. Constraints: 36 characters or less, Read-Only.

7. search-apps (relation)

Description: Search for apps using a creditorReference. Representations will be returned in a collection in descending order.

Properties

creditorReference: The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.