ID4i API
ID4i HTTP API
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
ID4i HTTP API
Endpoints 107
Accounts
- PUTVerify password reset
/account/passwordSetting a new password and verifying the request to set the password. - POSTRequest password reset
/account/passwordRequesting a reset for a new password. - PUTComplete registration
/account/registrationCompleting a registration e.g. for invited users. Finish registration with a username and a password. - POSTRegister user
/account/registrationRegistering a new user. - POSTVerify registration
/account/verificationVerifies a new user registration. - GETList users and their roles
/api/v1/organizations/:organizationId/roles?offset=0&limit=0Listing users and their roles in a paginated manner. - GETFind users in organization
/api/v1/organizations/:organizationId/users?offset=0&limit=0Finding users in the specified organization in a paginated manner. - POSTInvite Users
/api/v1/organizations/:organizationId/users/invite - GETGet user roles by username
/api/v1/organizations/:organizationId/users/:username/roles?offset=0&limit=0 - POSTAdd role(s) to user
/api/v1/organizations/:organizationId/users/:username/roles - DELETERemove role(s) from user
/api/v1/organizations/:organizationId/users/:username/roles - GETList roles
/api/v1/roles?privilege=string&offset=0&limit=0Listing of roles. - GETRetrieve organizations of user
/api/v1/user/organizations?role=string&offset=0&limit=0 - GETFind users
/api/v1/users?usernamePrefix=string&offset=0&limit=0 - GETFind by username
/api/v1/users/:username - POSTlogin
/loginID4i API Login
Alias
- GETGet all aliases for the given GUID or Collection.
/api/v1/id4ns/:id4n/aliasLooks up the alias for each alias type (group and single) and returns a map of all aliases found. - POSTAdd alias for GUID or Collection
/api/v1/id4ns/:id4n/alias/:aliasTypeAdds or replaces aliases for single ID4ns (alias type item and mapp) or groups of ID4ns (alias types gtin, ean and article) - DELETERemove aliases from GUID or Collection
/api/v1/id4ns/:id4n/alias/:aliasTypeRemove the alias of the given type - GETSearch for GUIDs by alias
/api/v1/search/guids?alias=string&aliasType=gtin&offset=0&limit=0 - GETList all supported alias types
/api/v1/search/guids/aliases/typesRetrieve this list to find out all alias types to use with alias search and change operations
Api Keys
- GETFind API key by organization
/api/v1/apikeys?organizationId=string&offset=0&limit=0Finding all API key assigned to the specified organization in a paginated manner. - POSTCreate API key
/api/v1/apikeysCreation of a new API key. - GETList all privileges
/api/v1/apikeys/privileges?id4nConcerning=true&offset=0&limit=0Listing all possible API key privileges. - GETShow API key
/api/v1/apikeys/:keyShowing the details of an API key. - PUTUpdate API keys
/api/v1/apikeys/:keyAPI keys can be updated with new labels, and be activated and deactivated. The secret or UUID cannot be changed. - DELETEDelete API key
/api/v1/apikeys/:keyDeletion of an API key. - GETList privileges
/api/v1/apikeys/:key/privileges?offset=0&limit=0 - POSTAdd privilege
/api/v1/apikeys/:key/privileges - DELETERemove privilege
/api/v1/apikeys/:key/privileges - GETID4ns of a privilege
/api/v1/apikeys/:key/privileges/:privilege/id4ns?offset=0&limit=0Listing ID4ns of a id4n concerning privilege - POSTAdd ID4ns of a privilege
/api/v1/apikeys/:key/privileges/:privilege/id4ns - DELETERemove id4ns of a privilege
/api/v1/apikeys/:key/privileges/:privilege/id4ns
Auditing
- GETList change log entries of an organization
/api/v1/changelog/organization/:organizationId/?messageMimeType=text/mustache&fromDate=2024-01-01T00:00:00Z&toDate=2024-01-01T00:00:00Z&offset=0&limit=0Listing change log entries of the specified organization id.
Billing
- GETGet billing amount of services for a given organization
/api/v1/billing/:organizationId?fromDate=2024-01-01T00:00:00Z&toDate=2024-01-01T00:00:00Z - GETGet billing positions for a given organization
/api/v1/billing/:organizationId/positions?fromDate=2024-01-01T00:00:00Z&toDate=2024-01-01T00:00:00Z
Collections
- POSTCreate collection
/api/v1/collections - GETFind collection
/api/v1/collections/:id4n - DELETEDelete collection
/api/v1/collections/:id4n - PATCHUpdate collection
/api/v1/collections/:id4nUpdate collection changing only the given values - GETList contents of the collection
/api/v1/collections/:id4n/elements?offset=0&limit=0&organizationId=string - POSTAdd elements to collection
/api/v1/collections/:id4n/elements - DELETERemove elements from collection
/api/v1/collections/:id4n/elements - GETRetrieve ID4n properties
/api/v1/id4ns/:id4n/properties?organizationId=stringList all properties of an id4n. - DELETEDelete ID4n properties
/api/v1/id4ns/:id4n/properties?organizationId=stringPartial deletion of id4n properties. If the property does not exist, it will be ignored. - PATCHPatch ID4n properties
/api/v1/id4ns/:id4n/properties?organizationId=stringPartial updating of id4n properties. If a property contains a null value the property will be deleted other values will be saved and overwritten if they… - GETGet multiple ID4n properties
/api/v1/multiple/id4ns/properties?id4ns=string&organizationId=stringGet a list of ID4n properties for the specified ID4ns. - GETGet collections of organization
/api/v1/organizations/:organizationId/collections?offset=0&limit=0&type=ROUTING_COLLECTION&label=string&labelPrefix=string&property=stringRetrieving all collections of an organization in a paginated manner. You may filter the results by specifying id4n properties with filter operations (eq, in,…
Guids
- POSTCreate GUID(s)
/api/v1/guidsCreating one or more GUIDs with a specified length. - GETRetrieve GUIDs not in any collection
/api/v1/guids/withoutCollection?organizationId=string&offset=0&limit=0 - GETRetrieve GUID information
/api/v1/guids/:id4n?organizationId=string - PATCHChange GUID information.
/api/v1/guids/:id4nAllows ownership transfer. - GETRetrieve ID4n information
/api/v1/id4ns/:id4n?organizationId=stringRetrieving basic information about an ID like the type and the creation time. - GETRetrieve collections of an ID
/api/v1/id4ns/:id4n/collections?organizationId=string&offset=0&limit=0Retrieving all owned or holding collections the specified id4n is assigned to. - POSTImport GS1/MAPP codes
/api/v1/import/gs1Importing GS1/MAPP codes that contain unique components.
History
- GETList history
/api/v1/history/:id4n?includePrivate=true&organization=string&type=CREATED&qualifier=string&fromDate=2024-01-01T00:00:00Z&toDate=2024-01-01T00:00:00Z&offset=0&limit=0Lists the history of a GUID - POSTAdd history item
/api/v1/history/:id4nAdd a new history item - GETDEPRECATED - List history
/api/v1/history/:id4n/:organizationId?includePrivate=true&offset=0&limit=0Deprecated. DEPRECATED - please use filteredList with organization parameter to achieve the same functionality - GETGet history item
/api/v1/history/:id4n/:organizationId/:sequenceId - PATCHUpdate history item
/api/v1/history/:id4n/:organizationId/:sequenceId - PUTSet history item visibility
/api/v1/history/:id4n/:organizationId/:sequenceId/visibility
Images
- GETResolve image
/api/v1/public/image/:imageID
Messaging
- GETgetDefaultQueue
/api/v1/organizations/:organizationId/messaging - PATCHpatchDefaultQueue
/api/v1/organizations/:organizationId/messaging - POSTEnqueue a custom message
/api/v1/organizations/:organizationId/messaging/enqueueCustomMessageEnqueue a custom organisation message with custom data.
Meta Information
- GETRetrieve version information about ID4i
/api/v1/infoRetrieving version information about ID4i.
Organizations
- GETList countries
/api/v1/countries?offset=0&limit=0 - POSTCreate organization
/api/v1/organizationsCreating a new organization. - GETFind organization by id/namespace
/api/v1/organizations/:organizationIdReturns a single organization. - PUTUpdate organization
/api/v1/organizations/:organizationId - DELETEDelete organization
/api/v1/organizations/:organizationId - GETRetrieve billing address
/api/v1/organizations/:organizationId/addresses/billing - PUTStore billing address
/api/v1/organizations/:organizationId/addresses/billing - DELETERemove billing address
/api/v1/organizations/:organizationId/addresses/billing - GETRetrieve address
/api/v1/organizations/:organizationId/addresses/default - PUTStore address
/api/v1/organizations/:organizationId/addresses/default - POSTUpdate organization logo
/api/v1/organizations/:organizationId/logoUpdating an organization logo using a multipart file upload. - DELETEDelete organization logo
/api/v1/organizations/:organizationId/logo - GETGet partners of an organization
/api/v1/organizations/:organizationId/partner?offset=0&limit=0Listing partners in a paginated manner. - PUTAdd partner
/api/v1/organizations/:organizationId/partnerAdding a partner organization. If the given organization is already a partner the result will be state 200 too. - DELETERemove partner
/api/v1/organizations/:organizationId/partnerRemoving a partner organization - GETList my privileges
/api/v1/organizations/:organizationId/privilegesListing all privileges of the current user/APIKey of the specified organization.
Public Services
- GETList public documents
/api/v1/public/documents/:id4n?organizationId=string&owner=string&offset=0&limit=0Listing all public documents of an id4n - GETRead public document contents
/api/v1/public/documents/:id4n/:organizationId/:fileName - GETRetrieve a public document (meta-data only, no content)
/api/v1/public/documents/:id4n/:organizationId/:fileName/metadata - GETShows the public history of the given GUID
/api/v1/public/history/:id4n?offset=0&limit=0Only contains public history items - GETRead public organization information
/api/v1/public/organizations/:organizationId - GETRetrieve all public routes for a GUID
/api/v1/public/routes/:id4n?type=web&interpolate=true - GETForward
/go/:guidForwarding to the designated route defined in the routing, - GETResolve owner of id4n
/whois/:id4n
Routing
- GETRetrieve routing file
/api/v1/routingfiles/:id4n?organizationId=string - PUTStore routing file
/api/v1/routingfiles/:id4n - GETRetrieve current route of a GUID (or ID4N)
/api/v1/routingfiles/:id4n/route/:type?privateRoutes=true&publicRoutes=true&interpolate=true - GETRetrieve all routes of a GUID (or ID4N)
/api/v1/routingfiles/:id4n/routes/:type?organizationId=string&interpolate=true
Storage
- GETList documents
/api/v1/documents/:id4n?owner=string&offset=0&limit=0Listing all documents of an id4n - GETList organization specific documents
/api/v1/documents/:id4n/:organizationId?owner=string&offset=0&limit=0Listing documents of an id4n seen by a specified organization - PUTPut an document for an id4n
/api/v1/documents/:id4n/:organizationIdCreating or overwriting an existing document - POSTCreate an document for an id4n
/api/v1/documents/:id4n/:organizationIdThe documents' mime type is suggested on octet-stream data. Otherwise the specified content mime type is used. - GETRead document contents
/api/v1/documents/:id4n/:organizationId/:fileName - DELETEDelete a document
/api/v1/documents/:id4n/:organizationId/:fileName - GETRetrieve a document (meta-data only, no content)
/api/v1/documents/:id4n/:organizationId/:fileName/metadata - PATCHUpdate a document
/api/v1/documents/:id4n/:organizationId/:fileName/metadata - GETRead data from microstorage
/api/v1/microstorage/:id4n/:organization - PUTWrite data to microstorage
/api/v1/microstorage/:id4n/:organization
Transfer
- PUTTransfer a GUID or collection, obtaining it (i.e. becoming the holder) and if allowed also taking ownership
/api/v1/transfers/:id4n/receiveInfoTaking ownership can be forbidden by a previous owner. See methods prepare and getInfo - GETShow transfer preparation information
/api/v1/transfers/:id4n/sendInfo - PUTPrepare an object for transfer
/api/v1/transfers/:id4n/sendInfo
API details
- Authentication
- An API key in the Authorization header
- Operations
- 107 operations on 70 pathsGET 56POST 19PUT 13DELETE 13PATCH 6
1 marked deprecated - Main resources
- Organizations 24Accounts 16Guids 14Storage 13Api Keys 12Collections 12Public Services 9History 6Alias 5Routing 4
- Response formats
application/jsonapplication/xml- Description format
- OpenAPI 3.0.0, API version
1.0.2 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the ID4i API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the ID4i API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Verify password reset” (PUT /account/password), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the ID4i API?
ID4i HTTP API It is listed under Other and has 107 endpoints.
Who publishes the ID4i API?
It is listed from Id4i's public API description (an OpenAPI document), not published by Id4i on Swastik Codes. Anyone who controls id4i.de can claim the profile by adding a DNS TXT record.
How do I authenticate with the ID4i API?
With an API key in the Authorization header.
How many endpoints does the ID4i API have?
107 operations on 70 paths (56 GET, 19 POST, 13 PUT, 13 DELETE, 6 PATCH). The largest groups are Organizations, Accounts, Guids, Storage.
Is forking the ID4i API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.