Even though Pics.io has an extensive library of integrations, there is always a place for custom integrations.
In order to cover more use cases of the DAM sphere, Pics.io introduces the ability to connect to various platforms such as your CMS, PIM, data warehouse, e-commerce, or social media tools using API.
NB! To enable API for your account, contact us via chat option or send us an email to support@pics.io to get an App ID.
Pics.io API is available with the Small and higher plans by default. Still, it is possible to enable API for other plans as a standalone service at an additional cost.
Benefits of our API:
Build your own connectors with applications you work most often with, such as WordPress, Salesforce, Magento, etc.
Upload new assets from your system directly into Pics.io DAM
Update metadata from other data sources
Enter metadata once and repurpose it across other systems
Connect assets to other customer experience technologies
See the impact of your digital assets with analytics tools
Application Program Interface (API) permits the interaction between Pics.io and other platforms. In simple terms, it is a technique that enables third-party vendors to write/connect programs that can easily interface with Pics.io.
What can I do with the help of API?
Using Pics.io API, you’ll be able to retrieve data from your Pics.io library beyond the Pics.io website. With the help of supported cross-origin resource sharing, it’s possible to securely interact with our API from client-side web applications.
Those interactions help build integrations that use the API to access Pics.io libraries, databases, and users. Integrations can connect services to Pics.io and build interactive experiences for users within Pics.io.
The REST API is recommended for most Pics.io DAM development if your custom application (web or other) needs to perform the following commands:
Assets:
Search assets, Get assets by IDs, Rename assets, Move assets to trash/Permanently delete assets/Restore assets from trash, Get the link for uploading, Create assets in Pics.io, Get thumbnails for assets by asset IDs, Get download link for an asset, Set a title for assets/Set a description for assets, Set rating for assets/Set flag for assets/Set a color for assets, Attach keyword to assets/Detach keyword from assets
Collections:
Get root collection, Search for collections, Create collection, Rename collection, Get collection children, Delete collection
Keywords:
Get all keywords, Add keyword, Delete keyword, Rename keyword, Attach keyword to assets, Detach keyword from assets
Custom fields:
Create custom field, Delete custom field, Get all custom fields, Update custom field
In the Pics.io DAM REST API, all resources in the platform are each assigned a unique URL. To interact with each resource, standard HTTP operators such as GET, PUT, POST, and DELETE can be used.
Feel free to check all API documentation here: https://api.pics.io/docs/
Here all the endpoints/methods are grouped into sections related to different functionality.
What to do once API is requested?
Once API access has been requested, you will be provided with the App ID required to obtain the API token needed to access the API clients. Open the Pics.io REST API page and follow the steps below.
Start using Pics.io API by obtaining a new API token. To access the API clients you should pass the secret API token in the HTTP Authorization header.
To obtain the access token, navigate to the Auth section of the documentation page, unfold the Login command tab, click the Try it out button and paste the App ID into the corresponding "X-Picsio-App-Id" field.
Once done, the email & password fields will become editable. Make sure to leave the quotation marks while substituting the login details with yours. The last step is to click the blue elongated 'Execute' button.
Once done, the "Server response" field will contain the access token that should be used for the Authorization. Make sure to scroll down to the bottom of the field to locate the accessToken along with the refreshToken rows.
Copy the accessToken and navigate to the beginning of the documentation page and locate the green 'Authorize' button within the header.
Click it and paste the copied token from the response body of the server response section.
NB! All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without the Authorization header will fail.
Any Questions?
Please mind that our API is currently in public beta!
If you get stuck or would like to report any issues, there is always our support@pics.io team to call for help.
N.B. Please make sure to specify your App ID in your support inquiry.