Pripost API

This is the first version of the PriPost API. The current functionality includes

  • Get postbox information

  • Get letters

  • Download letter files

  • Move letter to trash

To get an access token, please contact PriPost.

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/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/postboxes/{postbox_id}

Returns a single postbox

URI Parameters
HideShow
postbox_id
number (required) 

ID 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/postboxes/{postbox_id}/letters

Returns all letters currently in inbox

URI Parameters
HideShow
postbox_id
number (required) 

ID 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/postboxes/{postbox_id}/letters/{letter_id}

Returns a single letter

URI Parameters
HideShow
postbox_id
number (required) 

ID the postbox

letter_id
number (required) 

ID 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/postboxes/{postbox_id}/letters/{letter_id}

Moves a letter to trash

URI Parameters
HideShow
postbox_id
number (required) 

ID the postbox

letter_id
number (required) 

ID 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/postboxes/{postbox_id}/letters/{letter_id}/download

Downloads a letter file

URI Parameters
HideShow
postbox_id
number (required) 

ID the postbox

letter_id
number (required) 

ID the letter


Generated by aglio on 21 May 2019