Permit Operator API

Access requirements:

• A valid authentication token is required to access the API. How to authenticate your application
• This API have an option to provide only read access, or both read and write access. Read only will give access to GET-endpoints, while read/write will give access to all endpoints connected to this API. Note: Read only or read/write access must be specified when contacting Autopay representative to acquire the Client Credentials.
• Access to the Permit Operator API is offered as a paid service. Please contact your Autopay representative for details.

Available Permit Operator API specific resource:

• GET - Get landlords for an operator

GET - Get landlords for operator

This method returns all landlords belonging to the operator.

Endpoint

GET https://api.autopay.io/permit/v1/landlords

Request parameters:

• The HTTP headers must include a valid access token.
• The access token must include operator_id.

Success response:

HTTP Code: 200 OK

Example success response:

[
    {
        "landlord_display_name": "My landlord",
        "landlord_id": "b8148a3c-591d-4fc5-9d29-d2917393ed1c"
    }
]

Possible error ID-s:

Access to Permit E-commerce API endpoints

A valid access token for the Permit Operator API also gives access to the Permit E-commerce API. This is the API for managing tenants and their permit allocations. This API can be used as described on the Permit E-commerce API page with the access token provided in this API.

Requests:

• The HTTP headers must include a valid access token.
• The path must include the landlord ID, and for some endpoints the tenant ID and/or permit allocation ID.

GET - Get the available permit definitions

GET https://api.autopay.io/permit/v2/landlord/{landlordId}/permit_definitions

GET - Get tenants for a landlord

GET https://api.autopay.io/permit/v2/landlord/{landlordId}/tenants

PUT - Create a new tenant

PUT https://api.autopay.io/permit/v2/landlord/{landlordId}/tenant/new

GET - Get a tenants existing permit allocations

GET https://api.autopay.io/permit/v2/landlord/{landlordId}/tenant/{tenantId}

GET - Get a landlords existing permit allocations

GET https://api.autopay.io/permit/v2/landlord/{landlordId}/permit_allocations

PUT - Create a new permit allocation

PUT https://api.autopay.io/permit/v2/landlord/{landlordId}/permit_allocation

POST - Update permit allocation

POST https://api.autopay.io/permit/v2/landlord/{landlordId}/tenant/{tenantId}/permit_allocations/{permitAllocationId}

DELETE - Delete permit allocation

DELETE https://api.autopay.io/permit/v2/landlord/{landlordId}/tenant/{tenantId}/permit_allocations/{permitAllocationId}

Error handling for Permit E-commerce API

Access to Permit API endpoints

A valid access token for the Permit Operator API also gives access to the Permit API. This is the API for managing end user permits as a tenant. The API is extended with new urls including the tenant ID. When using the API with the authentication provided in this API, it is necessary to use the new URLs listed below. Detailed documentation for each endpoint can be found under each endpoint on the Permit API page.

Requests:

• The HTTP headers must include a valid access token.
• The path must include the tenant ID, and for some endpoints the permit ID.

GET - List all available permit allocations

GET https://api.autopay.io/permit/v3/tenants/{tenantId}/tenant_permit_allocations

GET - List all permits for a tenant

GET https://api.autopay.io/permit/v3/tenants/{tenantId}/tenant_issued_permits

POST - Give end-user a permit

POST https://api.autopay.io/permit/v3/tenants/{tenantId}/end_user_permit

PUT - Update end-user permit

PUT https://api.autopay.io/permit/v3/tenants/{tenantId}/end_user_permit/{permit_id}

DELETE - Remove end-user permit

DELETE https://api.autopay.io/permit/v3/tenants/{tenantId}/end_user_permit/{permit_id}

Error handling for Permit API