API Access addon

With the API Access add-on for CRIBWISE, customers can seamlessly create, read, update, and delete data within the system using a comprehensive array of API endpoints. This functionality empowers users to integrate CRIBWISE capabilities into their own applications, enhancing automation and efficiency. To utilize the API Access Add-on, customers must enable the “API All Access” add-on or one of the available add-ons that grant access to specific subsets of endpoints. This ensures flexible and tailored API usage, catering to diverse operational needs. Documentation for all available endpoints can be found here: https://api.developer.cribwise.com/apis

Adding API Access add-on to you subscription

Goto app.cribwise.com and sign-in with a customer account manager account. Once signed in goto the “Add-ons” tab and click “Buy new add-on”. On the middle of the page click the “Add new add-on” button.

In the pop-up shown select “Software” in the Type menu and then the applicable API add-on in the Add-on menu. A more detailed description of the capabilities that will be enabled will be shown along with the price for the add-on. If you require multiple of the add-ons you can repeat this step before you complete the order.

When the order is completed your account will be updated and access to the API will be enabled. This is usually completed within a few minutes.

API Access offering

CRIBWISE offers a variety of API add-ons that cater to different use-cases, allowing you to enhance and customize your system according to your specific needs. You can select individual API add-ons or opt for the API All Access add-on, which grants comprehensive access to all available and future endpoints. By selecting the appropriate API add-ons, you can ensure that your inventory management system is precisely configured to meet your unique business needs when it comes to integration with you other shop-floor applications. Below are the detailed descriptions of each API add-on:

API All Access

With the API All Access package, you gain unrestricted access to the entire range of CRIBWISE API endpoints, along with full access to the API Developer Portal. This package is ideal for those who require a versatile and expansive integration capability to cover all current and future functionalities.

API Cost Allocation

This add-on provides access to a suite of endpoints focused on managing cost allocations. It includes endpoints for managing CA hierarchy instances, CA instance item relations, CA instance user group relations, CA instance user relations, CA sets, CA steps, CA step types, and CA values. This is essential for detailed and hierarchical cost tracking and allocation within your system. Below you will find the exact endpoints that are enabled with this add-on:

API Master Data

The API Master Data add-on allows you to manage fundamental data across your inventory system. It includes endpoints for accessing and manipulating information related to manufacturers, vendors, order templates, and currencies. This add-on is critical for maintaining accurate and up-to-date master data records. Below you will find the exact endpoints that are enabled with this add-on:

API Items

Gain comprehensive control over your item-related data with the API Items add-on. This includes endpoints for item categories, item details, item description translations, serialized item instance documents, and serialized item instances. It is indispensable for detailed item management and tracking. Below you will find the exact endpoints that are enabled with this add-on:

API Purchase

The API Purchase add-on provides endpoints that cover the entire purchase process. This includes managing purchase orders, purchase order items, service orders, service order items, consignment invoice requests, and consignment invoice request items. It streamlines and enhances the efficiency of your procurement and service processes.

API Stock

Ensure effective stock management with the API Stock add-on. It includes endpoints for handling devices and stock levels, allowing you to keep accurate and real-time records of your inventory in external systems.

API Access Control

With the API Access Control add-on, you can manage user permissions and security within your system. It includes endpoints for users, user groups, and user keys, providing robust access control mechanisms to safeguard your inventory data.

API Reporting

The API Reporting add-on provides endpoints for generating and accessing reports. It includes support for both Reporting v1 and Reporting v2, enabling you to extract valuable insights and analytics from your inventory data.

API System Settings

Manage your system configurations effortlessly with the API System Settings add-on. It provides endpoints for accessing and modifying system settings and configurations, ensuring your inventory management system is tailored to your operational requirements.

• • • integration/v1/integrationapi/Settings/*

Requesting and using the access token

Before you can make a request to any of the API endpoints you need to request an access token for our Authentication API. This authentication call will require you to create a API key in the Admin Portal. This API key can only be create by a user with administrator access in your CRIBWISE instance.

Create API key

Login to your Admin Portal and select “Administration” in the left menu, then select “Integration” and finally select “API Keys”. To create a new API key click the “New key” icon in the top menu in the API keys pane. This will allow you to assign a name for the key and also a expiration date. Once set, click “Save key”.

Copy the generated API key. You can always come back and find the API key again if needed.

Request an access token

Make the below POST request to the https://api.cribwise.com/authentication/v1/connect/token endpoint to request an access token. The body should be of content type x-www-form-urlencoded.

POST /authentication/v1/connect/token HTTP/1.1
Accept: */*
Host: api.cribwise.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 123 

client_id=erp_client&client_secret=[your_api_key]&grant_type=client_credentials&scope=erp_api

{
"access_token":"eyJhbGciOiJSUzI1NiIsIm...",
"expires_in":3600,
"token_type":"Bearer",
"scope":"erp_api"
}

GET /integration/v1/integrationapi/Items HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsIm...
Accept: */*
Host: api.cribwise.com