Open documentation ↗Overview
Domain registriert bei united-domains.de
ID4i API is a business API from id4i.de. Requests are authenticated with an API key. It is served over plain HTTP. Its OpenAPI description documents 107 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- No
- CORS
- Unknown
- Category
- Business
- Version
- 1.0.2
- Endpoints
- 107
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-06
Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /account/password | Request password reset |
| PUT | /account/password | Verify password reset |
| POST | /account/registration | Register user |
| PUT | /account/registration | Complete registration |
| POST | /account/verification | Verify registration |
| GET | /api/v1/apikeys | Find API key by organization |
| POST | /api/v1/apikeys | Create API key |
| GET | /api/v1/apikeys/privileges | List all privileges |
| GET | /api/v1/apikeys/{key} | Show API key |
| PUT | /api/v1/apikeys/{key} | Update API keys |
| DELETE | /api/v1/apikeys/{key} | Delete API key |
| GET | /api/v1/apikeys/{key}/privileges | List privileges |
| POST | /api/v1/apikeys/{key}/privileges | Add privilege |
| DELETE | /api/v1/apikeys/{key}/privileges | Remove privilege |
| GET | /api/v1/apikeys/{key}/privileges/{privilege}/id4ns | ID4ns of a privilege |
| POST | /api/v1/apikeys/{key}/privileges/{privilege}/id4ns | Add ID4ns of a privilege |
| DELETE | /api/v1/apikeys/{key}/privileges/{privilege}/id4ns | Remove id4ns of a privilege |
| GET | /api/v1/billing/{organizationId} | Get billing amount of services for a given organization |
| GET | /api/v1/billing/{organizationId}/positions | Get billing positions for a given organization |
| GET | /api/v1/changelog/organization/{organizationId}/ | List change log entries of an organization |
| POST | /api/v1/collections | Create collection |
| GET | /api/v1/collections/{id4n} | Find collection |
| PATCH | /api/v1/collections/{id4n} | Update collection |
| DELETE | /api/v1/collections/{id4n} | Delete collection |
| GET | /api/v1/collections/{id4n}/elements | List contents of the collection |
| POST | /api/v1/collections/{id4n}/elements | Add elements to collection |
| DELETE | /api/v1/collections/{id4n}/elements | Remove elements from collection |
| GET | /api/v1/countries | List countries |
| GET | /api/v1/documents/{id4n} | List documents |
| GET | /api/v1/documents/{id4n}/{organizationId} | List organization specific documents |
| POST | /api/v1/documents/{id4n}/{organizationId} | Create an document for an id4n |
| PUT | /api/v1/documents/{id4n}/{organizationId} | Put an document for an id4n |
| GET | /api/v1/documents/{id4n}/{organizationId}/{fileName} | Read document contents |
| DELETE | /api/v1/documents/{id4n}/{organizationId}/{fileName} | Delete a document |
| GET | /api/v1/documents/{id4n}/{organizationId}/{fileName}/metadata | Retrieve a document (meta-data only, no content) |
| PATCH | /api/v1/documents/{id4n}/{organizationId}/{fileName}/metadata | Update a document |
| POST | /api/v1/guids | Create GUID(s) |
| GET | /api/v1/guids/withoutCollection | Retrieve GUIDs not in any collection |
| GET | /api/v1/guids/{id4n} | Retrieve GUID information |
| PATCH | /api/v1/guids/{id4n} | Change GUID information. |
| GET | /api/v1/history/{id4n} | List history |
| POST | /api/v1/history/{id4n} | Add history item |
| GET | /api/v1/history/{id4n}/{organizationId}deprecated | DEPRECATED - List history |
| GET | /api/v1/history/{id4n}/{organizationId}/{sequenceId} | Get history item |
| PATCH | /api/v1/history/{id4n}/{organizationId}/{sequenceId} | Update history item |
| PUT | /api/v1/history/{id4n}/{organizationId}/{sequenceId}/visibility | Set history item visibility |
| GET | /api/v1/id4ns/{id4n} | Retrieve ID4n information |
| GET | /api/v1/id4ns/{id4n}/alias | Get all aliases for the given GUID or Collection. |
| POST | /api/v1/id4ns/{id4n}/alias/{aliasType} | Add alias for GUID or Collection |
| DELETE | /api/v1/id4ns/{id4n}/alias/{aliasType} | Remove aliases from GUID or Collection |
| GET | /api/v1/id4ns/{id4n}/collections | Retrieve collections of an ID |
| GET | /api/v1/id4ns/{id4n}/properties | Retrieve ID4n properties |
| PATCH | /api/v1/id4ns/{id4n}/properties | Patch ID4n properties |
| DELETE | /api/v1/id4ns/{id4n}/properties | Delete ID4n properties |
| POST | /api/v1/import/gs1 | Import GS1/MAPP codes |
| GET | /api/v1/info | Retrieve version information about ID4i |
| GET | /api/v1/microstorage/{id4n}/{organization} | Read data from microstorage |
| PUT | /api/v1/microstorage/{id4n}/{organization} | Write data to microstorage |
| GET | /api/v1/multiple/id4ns/properties | Get multiple ID4n properties |
| POST | /api/v1/organizations | Create organization |
| GET | /api/v1/organizations/{organizationId} | Find organization by id/namespace |
| PUT | /api/v1/organizations/{organizationId} | Update organization |
| DELETE | /api/v1/organizations/{organizationId} | Delete organization |
| GET | /api/v1/organizations/{organizationId}/addresses/billing | Retrieve billing address |
| PUT | /api/v1/organizations/{organizationId}/addresses/billing | Store billing address |
| DELETE | /api/v1/organizations/{organizationId}/addresses/billing | Remove billing address |
| GET | /api/v1/organizations/{organizationId}/addresses/default | Retrieve address |
| PUT | /api/v1/organizations/{organizationId}/addresses/default | Store address |
| GET | /api/v1/organizations/{organizationId}/collections | Get collections of organization |
| POST | /api/v1/organizations/{organizationId}/logo | Update organization logo |
| DELETE | /api/v1/organizations/{organizationId}/logo | Delete organization logo |
| GET | /api/v1/organizations/{organizationId}/messaging | getDefaultQueue |
| PATCH | /api/v1/organizations/{organizationId}/messaging | patchDefaultQueue |
| POST | /api/v1/organizations/{organizationId}/messaging/enqueueCustomMessage | Enqueue a custom message |
| GET | /api/v1/organizations/{organizationId}/partner | Get partners of an organization |
| PUT | /api/v1/organizations/{organizationId}/partner | Add partner |
| DELETE | /api/v1/organizations/{organizationId}/partner | Remove partner |
| GET | /api/v1/organizations/{organizationId}/privileges | List my privileges |
| GET | /api/v1/organizations/{organizationId}/roles | List users and their roles |
| GET | /api/v1/organizations/{organizationId}/users | Find users in organization |
| POST | /api/v1/organizations/{organizationId}/users/invite | Invite Users |
| GET | /api/v1/organizations/{organizationId}/users/{username}/roles | Get user roles by username |
| POST | /api/v1/organizations/{organizationId}/users/{username}/roles | Add role(s) to user |
| DELETE | /api/v1/organizations/{organizationId}/users/{username}/roles | Remove role(s) from user |
| GET | /api/v1/public/documents/{id4n} | List public documents |
| GET | /api/v1/public/documents/{id4n}/{organizationId}/{fileName} | Read public document contents |
| GET | /api/v1/public/documents/{id4n}/{organizationId}/{fileName}/metadata | Retrieve a public document (meta-data only, no content) |
| GET | /api/v1/public/history/{id4n} | Shows the public history of the given GUID |
| GET | /api/v1/public/image/{imageID} | Resolve image |
| GET | /api/v1/public/organizations/{organizationId} | Read public organization information |
| GET | /api/v1/public/routes/{id4n} | Retrieve all public routes for a GUID |
| GET | /api/v1/roles | List roles |
| GET | /api/v1/routingfiles/{id4n} | Retrieve routing file |
| PUT | /api/v1/routingfiles/{id4n} | Store routing file |
| GET | /api/v1/routingfiles/{id4n}/route/{type} | Retrieve current route of a GUID (or ID4N) |
| GET | /api/v1/routingfiles/{id4n}/routes/{type} | Retrieve all routes of a GUID (or ID4N) |
| GET | /api/v1/search/guids | Search for GUIDs by alias |
| GET | /api/v1/search/guids/aliases/types | List all supported alias types |
| PUT | /api/v1/transfers/{id4n}/receiveInfo | Transfer a GUID or collection, obtaining it (i.e. becoming the holder) and if allowed also taking ownership |
| GET | /api/v1/transfers/{id4n}/sendInfo | Show transfer preparation information |
Showing the first 100 of 107 endpoints; the full list is in the documentation.
Questions
Does the ID4i API API need an API key?
Yes. The ID4i API API uses API key authentication; the documentation explains how to get credentials.
Does the ID4i API API support HTTPS?
The ID4i API API is listed as HTTP only, so avoid sending secrets to it.
How many endpoints does the ID4i API API have?
Its OpenAPI description lists 107 endpoints in version 1.0.2. The first 100 are shown on this page.
What are alternatives to the ID4i API API?
Other Business APIs include Gmail, Google Analytics, Apache Superset, Trello, Square.
Similar business APIs
Compare alternatives →Gmail
BusinessFlexible, RESTful access to the user's inbox
OAuth
Google Analytics
BusinessCollect, configure and analyze your data to reach the right audience
OAuth
Apache Superset
BusinessAPI to manage your BI dashboards and data sources on Superset
API keyCORS
Trello
BusinessBoards, lists and cards to help you organize and prioritize your projects
OAuth324 endpoints
Square
BusinessEasy way to take payments, manage refunds, and help customers checkout online
OAuth200 endpoints
Mailchimp
BusinessSend marketing campaigns and transactional mails
API key
Listed from APIs.guru (CC0).