Skip to content
/Subscriptions

(1.0.0)

Download OpenAPI description
document.json
document.yaml
Languages
Servers
Mock server
https://docs.insert.nl/_mock/apis/document/
https://accept-app.insert.nl/api/v1/

Authentication

Operations

Products

Operations

Projects

Operations

Subscriptions

Operations

List subscriptions

Request

Security
oauth2
curl -i -X GET \
  https://docs.insert.nl/_mock/apis/document/resources/subscriptions \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
countintegerrequired
subscriptionsArray of objects(SubscriptionResource)required
subscriptions[].​idstringrequired
subscriptions[].​resource_typestringrequired
Value"subscription"
subscriptions[].​urlstringrequired
subscriptions[].​created_datestringrequired
subscriptions[].​start_datestringrequired
subscriptions[].​end_datestringrequired
subscriptions[].​consumer_idstringrequired
Value"did:ishare:EU.NL.NTRNL-73085065"
subscriptions[].​provider_idstringrequired
Value"did:ishare:EU.NL.NTRNL-73085065"
subscriptions[].​descriptionstring or nullrequired
subscriptions[].​event_typestringrequired
subscriptions[].​statusstringrequired
Enum"active""inactive"
subscriptions[].​webhook_urlstringrequired
subscriptions[].​signing_secretstringrequired
Response
application/json
{
  "count": 0,
  "subscriptions": [
    { … }
  ]
}

Create subscription

Request

Security
oauth2
Bodyapplication/jsonrequired
resource_typestringrequired
Value"subscription"
start_datestring or null
end_datestring or null
webhook_urlstring(uri)required
event_typeArray of stringsrequired
Items Enum"created""updated""deleted"
curl -i -X POST \
  https://docs.insert.nl/_mock/apis/document/resources/subscriptions \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "resource_type": "subscription",
    "start_date": "string",
    "end_date": "string",
    "webhook_url": "http://example.com",
    "event_type": [
      "created"
    ]
  }'

Responses

SubscriptionResource

Bodyapplication/json
idstringrequired
resource_typestringrequired
Value"subscription"
urlstringrequired
created_datestringrequired
start_datestringrequired
end_datestringrequired
consumer_idstringrequired
Value"did:ishare:EU.NL.NTRNL-73085065"
provider_idstringrequired
Value"did:ishare:EU.NL.NTRNL-73085065"
descriptionstring or nullrequired
event_typestringrequired
statusstringrequired
Enum"active""inactive"
webhook_urlstringrequired
signing_secretstringrequired
Response
application/json
{
  "id": "string",
  "resource_type": "subscription",
  "url": "string",
  "created_date": "string",
  "start_date": "string",
  "end_date": "string",
  "consumer_id": "did:ishare:EU.NL.NTRNL-73085065",
  "provider_id": "did:ishare:EU.NL.NTRNL-73085065",
  "description": "string",
  "event_type": "string",
  "status": "active",
  "webhook_url": "string",
  "signing_secret": "string"
}

Get subscription

Request

Security
oauth2
Path
subscriptionstringrequired

The subscription UUID

curl -i -X GET \
  'https://docs.insert.nl/_mock/apis/document/resources/subscriptions/{subscription}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

SubscriptionResource

Bodyapplication/json
idstringrequired
resource_typestringrequired
Value"subscription"
urlstringrequired
created_datestringrequired
start_datestringrequired
end_datestringrequired
consumer_idstringrequired
Value"did:ishare:EU.NL.NTRNL-73085065"
provider_idstringrequired
Value"did:ishare:EU.NL.NTRNL-73085065"
descriptionstring or nullrequired
event_typestringrequired
statusstringrequired
Enum"active""inactive"
webhook_urlstringrequired
signing_secretstringrequired
Response
application/json
{
  "id": "string",
  "resource_type": "subscription",
  "url": "string",
  "created_date": "string",
  "start_date": "string",
  "end_date": "string",
  "consumer_id": "did:ishare:EU.NL.NTRNL-73085065",
  "provider_id": "did:ishare:EU.NL.NTRNL-73085065",
  "description": "string",
  "event_type": "string",
  "status": "active",
  "webhook_url": "string",
  "signing_secret": "string"
}

Delete subscription

Request

Security
oauth2
Path
subscriptionstringrequired

The subscription UUID

curl -i -X DELETE \
  'https://docs.insert.nl/_mock/apis/document/resources/subscriptions/{subscription}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
object
]
Response
application/json
[
  null
]

Test subscription

Request

Security
oauth2
Path
subscriptionstringrequired

The subscription UUID

curl -i -X POST \
  'https://docs.insert.nl/_mock/apis/document/resources/subscriptions/{subscription}/test' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response
No content