PriPortal API

API Endpoint
https://www.priportal.eu/api/v1

The current functionality includes:

  • Get postbox information

  • Get letters

  • Download letter files

  • Move letter to trash

To get an access token, please contact PriServices.

Login

Login using a supplied api key

When you have received a API key, you can use that as a Bearer token for communications with our server.

Please be aware, to enhance security, your system’s IP address that uses this token needs to be whitelisted in your account

To do so:

1 - Let your system access our API

2 - You will not have access, but the message mentions that the account holder received an email to whitelist the IP

3 - Login with the link supplied in that email

4 - Your system’s IP is now whitelisted and you can use our API

Login with your username/password

Returns the bearer and refresh tokens

POST https://www.priportal.eu/api/v1/auth/token
Requestswith body
  • Request Attributes (Bearer)
Headers
Content-Type: application/json
Body
{
  "grant_type": "password",
  "client_id": "<your supplied client_id>",
  "client_secret": "<your supplied client_secret>",
  "username": "<your username to login>",
  "password": "<your password>"
}
Responses200
Headers
Content-Type: application/json
Body
{
  "token_type": "Bearer",
  "expires_in": 31536000,
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjFhNWVmODRhYWVjNWFhYzc3YmJjYzNkNmM2YmJkYzJhNGYwNTIzOGQ0MDljYjQzYzk3MzQzNzE3NDQ0NjI4YmNiNWZmZDVmYzBhZmQ2ZmJmIn0",
  "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjFhNWVmODRhYWVjNWFhYzc3YmJjYzNkNmM2YmJkYzJhNGYwNTIzOGQ0MDljYjQzYzk3MzQzNzE3NDQ0NjI4YmNiNWZmZDVmYzBhZmQ2ZmJmIn0"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "token_type": {
      "type": "string"
    },
    "expires_in": {
      "type": "number"
    },
    "access_token": {
      "type": "string"
    },
    "refresh_token": {
      "type": "string"
    }
  }
}

login
POST/auth/token

Returns the bearer and refresh tokens

For this you need a client_id and a client_secret.

This information can be requested by contacting PriServices

Account

Get your account details

Login

Returns the bearer and refresh tokens

GET https://www.priportal.eu/api/v1/account
Requestsapplication/json
Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjFhNWVmODRhYWVjNWFhYzc3YmJjYzNkNmM2YmJkYzJhNGYwNTIzOGQ0MDljYjQzYzk3MzQzNzE3NDQ0NjI4YmNiNWZmZDVmYzBhZmQ2ZmJmIn0.eyJhdWQiOiIzIiwianRpIjoiMWE1ZWY4NGFhZWM1YWFjNzdiYmNjM2Q2YzZiYmRjMmE0ZjA1MjM4ZDQwOWNiNDNjOTczNDM3MTc0NDQ2MjhiY2I1ZmZkNWZjMGFmZDZmYmYiLCJpYXQiOjE1NTc4NDY0ODksIm5iZiI6MTU1Nzg0NjQ4OSwiZXhwIjoxNTg5NDY4ODg5LCJzdWIiOiIiLCJzY29wZXMiOltdfQ.Xs2uZsiGaIS5z_k4XG7xcYgq1MFFbK8N3A6zI5JuluTVq-SdDwFuw_H7QVOAX9VF1oF6sMi61fLVenyQmWdXKObZnoQ8QsTx7hnfhuDkUozWg5ZYdtkZ0kteQVc4t4GKrJ74qy9doyadF0RS3N9vnmZbBpAamcrnZXawk1ahveL9cCtcw-yaIeKYgtOOvKpM4O0H8DirIW0yHOK9371whk6RF1nIBYdLJ0xIAiHII_Q50xSm4y7cJNS-8AeB7QNLhbZXHTlE3ok9o1UgPRK6_zkN-asljihCqIzZdp0RtepZqCtBrDOeAT30E6LECvtDouznMDOGbPBwjdq5BuvFlDLSQFub0OiZTlOP6vs-fIL31B4A_FEyYrMCRSxbfKTRo4qx7mTxDLE7vjepG3JbxqHx2VMkqKXjr7OV3kZ2GcLzBc0jV_No5OtPusHGYFnXcFx-DpC7KVjATz1hCPCVepsX8qpiXq95k_WgOkKsA2GHyE9ZjTXBlKbGhQ5n64Z2scoWKxMqzcJrp58PMNd4HpK5oBMdaxATH135w4MSb8xr0YTrXlXDpD3Q3CAmyFT8gRTIHEdPfkx_Q9Kw9V0Gts4iSzLJZRbx5GFNq_Lp9mGHbX-0V3oU0g3XBEFwIIv11kRk2vF34bvoM1UxiDYjP00oUKteKlxE1lgqRLrOF_U
Accept: application/json
Responses200
Headers
Content-Type: application/json
Body
{
  "name": "Demo Johnson",
  "first_name": "Demo",
  "last_name": "Johnson",
  "email": "[email protected]",
  "sex": 1,
  "locale": "nl",
  "username": "demousername"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "sex": {
      "type": "number"
    },
    "locale": {
      "type": "string"
    },
    "username": {
      "type": "string"
    }
  }
}

account
GET/account

Returns your account information

PriParcel

Parcelboxes

GET https://www.priportal.eu/api/v1/priparcel/parcelboxes
Requestsapplication/json
Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjFhNWVmODRhYWVjNWFhYzc3YmJjYzNkNmM2YmJkYzJhNGYwNTIzOGQ0MDljYjQzYzk3MzQzNzE3NDQ0NjI4YmNiNWZmZDVmYzBhZmQ2ZmJmIn0.eyJhdWQiOiIzIiwianRpIjoiMWE1ZWY4NGFhZWM1YWFjNzdiYmNjM2Q2YzZiYmRjMmE0ZjA1MjM4ZDQwOWNiNDNjOTczNDM3MTc0NDQ2MjhiY2I1ZmZkNWZjMGFmZDZmYmYiLCJpYXQiOjE1NTc4NDY0ODksIm5iZiI6MTU1Nzg0NjQ4OSwiZXhwIjoxNTg5NDY4ODg5LCJzdWIiOiIiLCJzY29wZXMiOltdfQ.Xs2uZsiGaIS5z_k4XG7xcYgq1MFFbK8N3A6zI5JuluTVq-SdDwFuw_H7QVOAX9VF1oF6sMi61fLVenyQmWdXKObZnoQ8QsTx7hnfhuDkUozWg5ZYdtkZ0kteQVc4t4GKrJ74qy9doyadF0RS3N9vnmZbBpAamcrnZXawk1ahveL9cCtcw-yaIeKYgtOOvKpM4O0H8DirIW0yHOK9371whk6RF1nIBYdLJ0xIAiHII_Q50xSm4y7cJNS-8AeB7QNLhbZXHTlE3ok9o1UgPRK6_zkN-asljihCqIzZdp0RtepZqCtBrDOeAT30E6LECvtDouznMDOGbPBwjdq5BuvFlDLSQFub0OiZTlOP6vs-fIL31B4A_FEyYrMCRSxbfKTRo4qx7mTxDLE7vjepG3JbxqHx2VMkqKXjr7OV3kZ2GcLzBc0jV_No5OtPusHGYFnXcFx-DpC7KVjATz1hCPCVepsX8qpiXq95k_WgOkKsA2GHyE9ZjTXBlKbGhQ5n64Z2scoWKxMqzcJrp58PMNd4HpK5oBMdaxATH135w4MSb8xr0YTrXlXDpD3Q3CAmyFT8gRTIHEdPfkx_Q9Kw9V0Gts4iSzLJZRbx5GFNq_Lp9mGHbX-0V3oU0g3XBEFwIIv11kRk2vF34bvoM1UxiDYjP00oUKteKlxE1lgqRLrOF_U
Accept: application/json
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "number": "PRIPAR00000001",
    "slug": "1-PRIPAR00000001"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

getAllParcelboxes
GET/priparcel/parcelboxes

  • Get all your parcelboxes

Parcels Received

  • Get parcels received
GET https://www.priportal.eu/api/v1/priparcel/parcelboxes/parcelbox_slug/parcels/received
Requestsapplication/json
Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjFhNWVmODRhYWVjNWFhYzc3YmJjYzNkNmM2YmJkYzJhNGYwNTIzOGQ0MDljYjQzYzk3MzQzNzE3NDQ0NjI4YmNiNWZmZDVmYzBhZmQ2ZmJmIn0.eyJhdWQiOiIzIiwianRpIjoiMWE1ZWY4NGFhZWM1YWFjNzdiYmNjM2Q2YzZiYmRjMmE0ZjA1MjM4ZDQwOWNiNDNjOTczNDM3MTc0NDQ2MjhiY2I1ZmZkNWZjMGFmZDZmYmYiLCJpYXQiOjE1NTc4NDY0ODksIm5iZiI6MTU1Nzg0NjQ4OSwiZXhwIjoxNTg5NDY4ODg5LCJzdWIiOiIiLCJzY29wZXMiOltdfQ.Xs2uZsiGaIS5z_k4XG7xcYgq1MFFbK8N3A6zI5JuluTVq-SdDwFuw_H7QVOAX9VF1oF6sMi61fLVenyQmWdXKObZnoQ8QsTx7hnfhuDkUozWg5ZYdtkZ0kteQVc4t4GKrJ74qy9doyadF0RS3N9vnmZbBpAamcrnZXawk1ahveL9cCtcw-yaIeKYgtOOvKpM4O0H8DirIW0yHOK9371whk6RF1nIBYdLJ0xIAiHII_Q50xSm4y7cJNS-8AeB7QNLhbZXHTlE3ok9o1UgPRK6_zkN-asljihCqIzZdp0RtepZqCtBrDOeAT30E6LECvtDouznMDOGbPBwjdq5BuvFlDLSQFub0OiZTlOP6vs-fIL31B4A_FEyYrMCRSxbfKTRo4qx7mTxDLE7vjepG3JbxqHx2VMkqKXjr7OV3kZ2GcLzBc0jV_No5OtPusHGYFnXcFx-DpC7KVjATz1hCPCVepsX8qpiXq95k_WgOkKsA2GHyE9ZjTXBlKbGhQ5n64Z2scoWKxMqzcJrp58PMNd4HpK5oBMdaxATH135w4MSb8xr0YTrXlXDpD3Q3CAmyFT8gRTIHEdPfkx_Q9Kw9V0Gts4iSzLJZRbx5GFNq_Lp9mGHbX-0V3oU0g3XBEFwIIv11kRk2vF34bvoM1UxiDYjP00oUKteKlxE1lgqRLrOF_U
Accept: application/json
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "id": 1,
    "date": "2020-10-19T22:00:00.000000Z",
    "has_images": true,
    "arrival_date": "2020-10-19T22:00:00.000000Z",
    "shipment_id": 1,
    "weight": 10,
    "waiting_for_decision": true,
    "file_names": [
      "PAR-NL1-2000001_01.jpg"
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

getAllParcelsReceived
GET/priparcel/parcelboxes/{parcelbox_slug}/parcels/received

URI Parameters
HideShow
parcelbox_slug
string (required) 

Slug of your parcelbox

Postboxes

Postbox information

Postboxes

GET https://www.priportal.eu/api/v1/pripost/postboxes
Requestsapplication/json
Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjFhNWVmODRhYWVjNWFhYzc3YmJjYzNkNmM2YmJkYzJhNGYwNTIzOGQ0MDljYjQzYzk3MzQzNzE3NDQ0NjI4YmNiNWZmZDVmYzBhZmQ2ZmJmIn0.eyJhdWQiOiIzIiwianRpIjoiMWE1ZWY4NGFhZWM1YWFjNzdiYmNjM2Q2YzZiYmRjMmE0ZjA1MjM4ZDQwOWNiNDNjOTczNDM3MTc0NDQ2MjhiY2I1ZmZkNWZjMGFmZDZmYmYiLCJpYXQiOjE1NTc4NDY0ODksIm5iZiI6MTU1Nzg0NjQ4OSwiZXhwIjoxNTg5NDY4ODg5LCJzdWIiOiIiLCJzY29wZXMiOltdfQ.Xs2uZsiGaIS5z_k4XG7xcYgq1MFFbK8N3A6zI5JuluTVq-SdDwFuw_H7QVOAX9VF1oF6sMi61fLVenyQmWdXKObZnoQ8QsTx7hnfhuDkUozWg5ZYdtkZ0kteQVc4t4GKrJ74qy9doyadF0RS3N9vnmZbBpAamcrnZXawk1ahveL9cCtcw-yaIeKYgtOOvKpM4O0H8DirIW0yHOK9371whk6RF1nIBYdLJ0xIAiHII_Q50xSm4y7cJNS-8AeB7QNLhbZXHTlE3ok9o1UgPRK6_zkN-asljihCqIzZdp0RtepZqCtBrDOeAT30E6LECvtDouznMDOGbPBwjdq5BuvFlDLSQFub0OiZTlOP6vs-fIL31B4A_FEyYrMCRSxbfKTRo4qx7mTxDLE7vjepG3JbxqHx2VMkqKXjr7OV3kZ2GcLzBc0jV_No5OtPusHGYFnXcFx-DpC7KVjATz1hCPCVepsX8qpiXq95k_WgOkKsA2GHyE9ZjTXBlKbGhQ5n64Z2scoWKxMqzcJrp58PMNd4HpK5oBMdaxATH135w4MSb8xr0YTrXlXDpD3Q3CAmyFT8gRTIHEdPfkx_Q9Kw9V0Gts4iSzLJZRbx5GFNq_Lp9mGHbX-0V3oU0g3XBEFwIIv11kRk2vF34bvoM1UxiDYjP00oUKteKlxE1lgqRLrOF_U
Responses200404
Headers
Content-Type: application/json
Body
[
  {
    "id": 45,
    "full_number": "B0001",
    "submit_date": "2019-05-02",
    "activation_date": "2019-05-06",
    "is_active": true,
    "location": {
      "id": 1,
      "name": "Leidschendam",
      "country": {
        "id": 157,
        "name": "Nederland"
      }
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Headers
Content-Type: application/json
Body
{
  "error": "Postbox with id '45' not found."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    }
  },
  "required": [
    "error"
  ]
}

getAllPostboxes
GET/pripost/postboxes

Returns all postboxes in your account

Postboxes By Postbox Id

GET https://www.priportal.eu/api/v1/pripost/postboxes/postbox_id
Requestsapplication/json
Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjFhNWVmODRhYWVjNWFhYzc3YmJjYzNkNmM2YmJkYzJhNGYwNTIzOGQ0MDljYjQzYzk3MzQzNzE3NDQ0NjI4YmNiNWZmZDVmYzBhZmQ2ZmJmIn0.eyJhdWQiOiIzIiwianRpIjoiMWE1ZWY4NGFhZWM1YWFjNzdiYmNjM2Q2YzZiYmRjMmE0ZjA1MjM4ZDQwOWNiNDNjOTczNDM3MTc0NDQ2MjhiY2I1ZmZkNWZjMGFmZDZmYmYiLCJpYXQiOjE1NTc4NDY0ODksIm5iZiI6MTU1Nzg0NjQ4OSwiZXhwIjoxNTg5NDY4ODg5LCJzdWIiOiIiLCJzY29wZXMiOltdfQ.Xs2uZsiGaIS5z_k4XG7xcYgq1MFFbK8N3A6zI5JuluTVq-SdDwFuw_H7QVOAX9VF1oF6sMi61fLVenyQmWdXKObZnoQ8QsTx7hnfhuDkUozWg5ZYdtkZ0kteQVc4t4GKrJ74qy9doyadF0RS3N9vnmZbBpAamcrnZXawk1ahveL9cCtcw-yaIeKYgtOOvKpM4O0H8DirIW0yHOK9371whk6RF1nIBYdLJ0xIAiHII_Q50xSm4y7cJNS-8AeB7QNLhbZXHTlE3ok9o1UgPRK6_zkN-asljihCqIzZdp0RtepZqCtBrDOeAT30E6LECvtDouznMDOGbPBwjdq5BuvFlDLSQFub0OiZTlOP6vs-fIL31B4A_FEyYrMCRSxbfKTRo4qx7mTxDLE7vjepG3JbxqHx2VMkqKXjr7OV3kZ2GcLzBc0jV_No5OtPusHGYFnXcFx-DpC7KVjATz1hCPCVepsX8qpiXq95k_WgOkKsA2GHyE9ZjTXBlKbGhQ5n64Z2scoWKxMqzcJrp58PMNd4HpK5oBMdaxATH135w4MSb8xr0YTrXlXDpD3Q3CAmyFT8gRTIHEdPfkx_Q9Kw9V0Gts4iSzLJZRbx5GFNq_Lp9mGHbX-0V3oU0g3XBEFwIIv11kRk2vF34bvoM1UxiDYjP00oUKteKlxE1lgqRLrOF_U
Responses200404
Headers
Content-Type: application/json
Body
{
  "id": 45,
  "full_number": "B0001",
  "submit_date": "2019-05-02",
  "activation_date": "2019-05-06",
  "is_active": true,
  "location": {
    "id": 1,
    "name": "Leidschendam",
    "country": {
      "id": 157,
      "name": "Nederland"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "full_number": {
      "type": "string"
    },
    "submit_date": {
      "type": "string"
    },
    "activation_date": {
      "type": "string"
    },
    "is_active": {
      "type": "boolean"
    },
    "location": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "country": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "required": [
    "id"
  ]
}
Headers
Content-Type: application/json
Body
{
  "error": "Postbox with id '45' not found."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    }
  },
  "required": [
    "error"
  ]
}

getPostboxById
GET/pripost/postboxes/{postbox_id}

Returns a single postbox

URI Parameters
HideShow
postbox_id
number (required) 

ID of the postbox

Letters

Fetching letters, download PDF and move to trash

Postboxes Letters By Postbox Id

GET https://www.priportal.eu/api/v1/pripost/postboxes/postbox_id/letters
Requestsapplication/json
Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjFhNWVmODRhYWVjNWFhYzc3YmJjYzNkNmM2YmJkYzJhNGYwNTIzOGQ0MDljYjQzYzk3MzQzNzE3NDQ0NjI4YmNiNWZmZDVmYzBhZmQ2ZmJmIn0.eyJhdWQiOiIzIiwianRpIjoiMWE1ZWY4NGFhZWM1YWFjNzdiYmNjM2Q2YzZiYmRjMmE0ZjA1MjM4ZDQwOWNiNDNjOTczNDM3MTc0NDQ2MjhiY2I1ZmZkNWZjMGFmZDZmYmYiLCJpYXQiOjE1NTc4NDY0ODksIm5iZiI6MTU1Nzg0NjQ4OSwiZXhwIjoxNTg5NDY4ODg5LCJzdWIiOiIiLCJzY29wZXMiOltdfQ.Xs2uZsiGaIS5z_k4XG7xcYgq1MFFbK8N3A6zI5JuluTVq-SdDwFuw_H7QVOAX9VF1oF6sMi61fLVenyQmWdXKObZnoQ8QsTx7hnfhuDkUozWg5ZYdtkZ0kteQVc4t4GKrJ74qy9doyadF0RS3N9vnmZbBpAamcrnZXawk1ahveL9cCtcw-yaIeKYgtOOvKpM4O0H8DirIW0yHOK9371whk6RF1nIBYdLJ0xIAiHII_Q50xSm4y7cJNS-8AeB7QNLhbZXHTlE3ok9o1UgPRK6_zkN-asljihCqIzZdp0RtepZqCtBrDOeAT30E6LECvtDouznMDOGbPBwjdq5BuvFlDLSQFub0OiZTlOP6vs-fIL31B4A_FEyYrMCRSxbfKTRo4qx7mTxDLE7vjepG3JbxqHx2VMkqKXjr7OV3kZ2GcLzBc0jV_No5OtPusHGYFnXcFx-DpC7KVjATz1hCPCVepsX8qpiXq95k_WgOkKsA2GHyE9ZjTXBlKbGhQ5n64Z2scoWKxMqzcJrp58PMNd4HpK5oBMdaxATH135w4MSb8xr0YTrXlXDpD3Q3CAmyFT8gRTIHEdPfkx_Q9Kw9V0Gts4iSzLJZRbx5GFNq_Lp9mGHbX-0V3oU0g3XBEFwIIv11kRk2vF34bvoM1UxiDYjP00oUKteKlxE1lgqRLrOF_U
Responses200404
Headers
Content-Type: application/json
Body
[
  {
    "id": 45,
    "number_of_pages": 10,
    "is_registered": false,
    "archived": false,
    "trashed_at": "Hello, world!",
    "state": 14,
    "state_text": "Afgerond",
    "last_updated": "2019-05-13",
    "folder": {
      "id": 13,
      "name": "Test folder"
    },
    "history": [
      {
        "state": 8,
        "state_text": "Inhoud is gescand",
        "processed_date": "2019-05-13"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Headers
Content-Type: application/json
Body
{
  "error": "Letter with id '123' not found."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    }
  },
  "required": [
    "error"
  ]
}

getAllLetters
GET/pripost/postboxes/{postbox_id}/letters

Returns all letters currently in inbox

URI Parameters
HideShow
postbox_id
number (required) 

ID of the postbox

Postboxes Letters By Postbox Id

GET https://www.priportal.eu/api/v1/pripost/postboxes/postbox_id/letters/letter_id
Requestsapplication/json
Headers
Authorization: `Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjFhNWVmODRhYWVjNWFhYzc3YmJjYzNkNmM2YmJkYzJhNGYwNTIzOGQ0MDljYjQzYzk3MzQzNzE3NDQ0NjI4YmNiNWZmZDVmYzBhZmQ2ZmJmIn0.eyJhdWQiOiIzIiwianRpIjoiMWE1ZWY4NGFhZWM1YWFjNzdiYmNjM2Q2YzZiYmRjMmE0ZjA1MjM4ZDQwOWNiNDNjOTczNDM3MTc0NDQ2MjhiY2I1ZmZkNWZjMGFmZDZmYmYiLCJpYXQiOjE1NTc4NDY0ODksIm5iZiI6MTU1Nzg0NjQ4OSwiZXhwIjoxNTg5NDY4ODg5LCJzdWIiOiIiLCJzY29wZXMiOltdfQ.Xs2uZsiGaIS5z_k4XG7xcYgq1MFFbK8N3A6zI5JuluTVq-SdDwFuw_H7QVOAX9VF1oF6sMi61fLVenyQmWdXKObZnoQ8QsTx7hnfhuDkUozWg5ZYdtkZ0kteQVc4t4GKrJ74qy9doyadF0RS3N9vnmZbBpAamcrnZXawk1ahveL9cCtcw-yaIeKYgtOOvKpM4O0H8DirIW0yHOK9371whk6RF1nIBYdLJ0xIAiHII_Q50xSm4y7cJNS-8AeB7QNLhbZXHTlE3ok9o1UgPRK6_zkN-asljihCqIzZdp0RtepZqCtBrDOeAT30E6LECvtDouznMDOGbPBwjdq5BuvFlDLSQFub0OiZTlOP6vs-fIL31B4A_FEyYrMCRSxbfKTRo4qx7mTxDLE7vjepG3JbxqHx2VMkqKXjr7OV3kZ2GcLzBc0jV_No5OtPusHGYFnXcFx-DpC7KVjATz1hCPCVepsX8qpiXq95k_WgOkKsA2GHyE9ZjTXBlKbGhQ5n64Z2scoWKxMqzcJrp58PMNd4HpK5oBMdaxATH135w4MSb8xr0YTrXlXDpD3Q3CAmyFT8gRTIHEdPfkx_Q9Kw9V0Gts4iSzLJZRbx5GFNq_Lp9mGHbX-0V3oU0g3XBEFwIIv11kRk2vF34bvoM1UxiDYjP00oUKteKlxE1lgqRLrOF_U`
Responses200404
Headers
Content-Type: application/json
Body
{
  "id": 45,
  "number_of_pages": 10,
  "is_registered": false,
  "archived": false,
  "trashed_at": "Hello, world!",
  "state": 14,
  "state_text": "Afgerond",
  "last_updated": "2019-05-13",
  "folder": {
    "id": 13,
    "name": "Test folder"
  },
  "history": [
    {
      "state": 8,
      "state_text": "Inhoud is gescand",
      "processed_date": "2019-05-13"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "number_of_pages": {
      "type": "number"
    },
    "is_registered": {
      "type": "boolean"
    },
    "archived": {
      "type": "boolean"
    },
    "trashed_at": {
      "type": "string"
    },
    "state": {
      "type": "number"
    },
    "state_text": {
      "type": "string"
    },
    "last_updated": {
      "type": "string"
    },
    "folder": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "history": {
      "type": "array"
    }
  },
  "required": [
    "id"
  ]
}
Headers
Content-Type: application/json
Body
{
  "error": "Letter with id '123' not found."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    }
  },
  "required": [
    "error"
  ]
}

getLetterById
GET/pripost/postboxes/{postbox_id}/letters/{letter_id}

Returns a single letter

URI Parameters
HideShow
postbox_id
number (required) 

ID of the postbox

letter_id
number (required) 

ID of the letter

DELETE https://www.priportal.eu/api/v1/pripost/postboxes/postbox_id/letters/letter_id
Requestsapplication/json
Headers
Authorization: `Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjFhNWVmODRhYWVjNWFhYzc3YmJjYzNkNmM2YmJkYzJhNGYwNTIzOGQ0MDljYjQzYzk3MzQzNzE3NDQ0NjI4YmNiNWZmZDVmYzBhZmQ2ZmJmIn0.eyJhdWQiOiIzIiwianRpIjoiMWE1ZWY4NGFhZWM1YWFjNzdiYmNjM2Q2YzZiYmRjMmE0ZjA1MjM4ZDQwOWNiNDNjOTczNDM3MTc0NDQ2MjhiY2I1ZmZkNWZjMGFmZDZmYmYiLCJpYXQiOjE1NTc4NDY0ODksIm5iZiI6MTU1Nzg0NjQ4OSwiZXhwIjoxNTg5NDY4ODg5LCJzdWIiOiIiLCJzY29wZXMiOltdfQ.Xs2uZsiGaIS5z_k4XG7xcYgq1MFFbK8N3A6zI5JuluTVq-SdDwFuw_H7QVOAX9VF1oF6sMi61fLVenyQmWdXKObZnoQ8QsTx7hnfhuDkUozWg5ZYdtkZ0kteQVc4t4GKrJ74qy9doyadF0RS3N9vnmZbBpAamcrnZXawk1ahveL9cCtcw-yaIeKYgtOOvKpM4O0H8DirIW0yHOK9371whk6RF1nIBYdLJ0xIAiHII_Q50xSm4y7cJNS-8AeB7QNLhbZXHTlE3ok9o1UgPRK6_zkN-asljihCqIzZdp0RtepZqCtBrDOeAT30E6LECvtDouznMDOGbPBwjdq5BuvFlDLSQFub0OiZTlOP6vs-fIL31B4A_FEyYrMCRSxbfKTRo4qx7mTxDLE7vjepG3JbxqHx2VMkqKXjr7OV3kZ2GcLzBc0jV_No5OtPusHGYFnXcFx-DpC7KVjATz1hCPCVepsX8qpiXq95k_WgOkKsA2GHyE9ZjTXBlKbGhQ5n64Z2scoWKxMqzcJrp58PMNd4HpK5oBMdaxATH135w4MSb8xr0YTrXlXDpD3Q3CAmyFT8gRTIHEdPfkx_Q9Kw9V0Gts4iSzLJZRbx5GFNq_Lp9mGHbX-0V3oU0g3XBEFwIIv11kRk2vF34bvoM1UxiDYjP00oUKteKlxE1lgqRLrOF_U`
Responses200404
This response has no content.
Headers
Content-Type: application/json
Body
{
  "error": "Letter with id '123' not found."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    }
  },
  "required": [
    "error"
  ]
}

deleteLetter
DELETE/pripost/postboxes/{postbox_id}/letters/{letter_id}

Moves a letter to trash

URI Parameters
HideShow
postbox_id
number (required) 

ID of the postbox

letter_id
number (required) 

ID of the letter

Postboxes Letters Download By Postbox Id

GET https://www.priportal.eu/api/v1/pripost/postboxes/postbox_id/letters/letter_id/download
Requestsapplication/json
Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjFhNWVmODRhYWVjNWFhYzc3YmJjYzNkNmM2YmJkYzJhNGYwNTIzOGQ0MDljYjQzYzk3MzQzNzE3NDQ0NjI4YmNiNWZmZDVmYzBhZmQ2ZmJmIn0.eyJhdWQiOiIzIiwianRpIjoiMWE1ZWY4NGFhZWM1YWFjNzdiYmNjM2Q2YzZiYmRjMmE0ZjA1MjM4ZDQwOWNiNDNjOTczNDM3MTc0NDQ2MjhiY2I1ZmZkNWZjMGFmZDZmYmYiLCJpYXQiOjE1NTc4NDY0ODksIm5iZiI6MTU1Nzg0NjQ4OSwiZXhwIjoxNTg5NDY4ODg5LCJzdWIiOiIiLCJzY29wZXMiOltdfQ.Xs2uZsiGaIS5z_k4XG7xcYgq1MFFbK8N3A6zI5JuluTVq-SdDwFuw_H7QVOAX9VF1oF6sMi61fLVenyQmWdXKObZnoQ8QsTx7hnfhuDkUozWg5ZYdtkZ0kteQVc4t4GKrJ74qy9doyadF0RS3N9vnmZbBpAamcrnZXawk1ahveL9cCtcw-yaIeKYgtOOvKpM4O0H8DirIW0yHOK9371whk6RF1nIBYdLJ0xIAiHII_Q50xSm4y7cJNS-8AeB7QNLhbZXHTlE3ok9o1UgPRK6_zkN-asljihCqIzZdp0RtepZqCtBrDOeAT30E6LECvtDouznMDOGbPBwjdq5BuvFlDLSQFub0OiZTlOP6vs-fIL31B4A_FEyYrMCRSxbfKTRo4qx7mTxDLE7vjepG3JbxqHx2VMkqKXjr7OV3kZ2GcLzBc0jV_No5OtPusHGYFnXcFx-DpC7KVjATz1hCPCVepsX8qpiXq95k_WgOkKsA2GHyE9ZjTXBlKbGhQ5n64Z2scoWKxMqzcJrp58PMNd4HpK5oBMdaxATH135w4MSb8xr0YTrXlXDpD3Q3CAmyFT8gRTIHEdPfkx_Q9Kw9V0Gts4iSzLJZRbx5GFNq_Lp9mGHbX-0V3oU0g3XBEFwIIv11kRk2vF34bvoM1UxiDYjP00oUKteKlxE1lgqRLrOF_U
Responses204
This response has no content.

uploadFile
GET/pripost/postboxes/{postbox_id}/letters/{letter_id}/download

Downloads a letter file

URI Parameters
HideShow
postbox_id
number (required) 

ID of the postbox

letter_id
number (required) 

ID of the letter

Generated by aglio on 04 Nov 2020