Integration Steps & Milestones

this guide outlines the necessary steps to successfully integrate with the paccurate api, enabling your platform to leverage our advanced cartonization intelligence following these steps will ensure a smooth integration process, maximizing the value for your customers, your platform, and paccurate 1\ obtain your trial key visit manage paccurate io and sign up for a trial key the trial key is essential as it provides the necessary access to the paccurate api, enabling partners to explore its capabilities and initiate the development process this step is important because it allows partners to test the api in a risk free environment, gaining a clear understanding of its functionality before committing to a full integration for paccurate, this controlled access helps in providing initial support and managing access during the evaluation phase 2\ review the api schema visit api paccurate io/docs to review the api schema reviewing the api schema is a critical step for partners to understand how to structure their requests and correctly process the responses from paccurate's api a thorough understanding of the schema at this stage is important as it prevents errors and saves significant development time later in the integration process additionally, visit docs paccurate io http //docs paccurate io to review some common use cases as well as understand more advanced features of the api and how to leverage them this clarity in documentation minimizes integration issues, accelerates development, and reduces the volume of support requests related to basic api usage 3\ identify trigger events and record storage determine where in your software is the appropriate place to call paccurate, and how the cartonization response should be stored identifying the specific events that will initiate a cartonization call to the paccurate api and determining the storage location for the api responses is a vital step this process establishes the fundamental workflow for when and how paccurate's cartonization logic is invoked within the partner's system proper planning at this stage is crucial as it ensures seamless automation, aligning the integration with the partner system's architecture for optimal efficiency, and providing customers with a streamlined shipping process through cartonization triggered at the most relevant points in their workflow for paccurate, this ensures effective api utilization, maximizing value and reducing unnecessary calls 4\ develop middleware develop any data mutation or transformation middleware to match order, item, and carton schemas the development of data mutation middleware is often necessary to ensure compatibility between the partner's data schemas (order, item, and carton) and paccurate's api requirements this middleware acts as a translator ensuring smooth data exchange and prevents errors during the integration this benefits partners by enabling integration without requiring a complete restructuring of their existing data model, and it allows customers to use their existing data with paccurate standardizing data input simplifies processing and enhances the accuracy of cartonization results from the paccurate api as a best practice, include some sort of record identifier with each request to associate api calls with orders, shipments, or waves this is typically included in the orderid or requestid field sent to paccurate 💡 api endpoints enterprise customers https //cloud api paccurate io resource enabled customers https //resources api paccurate io 5\ make a test api call once the middleware is ready, make a test call to our api using your trial key making a test call to the paccurate api with the trial key is a critical validation step this confirms that the middleware is functioning correctly and that the connection to the paccurate api has been successfully established this step allows for the early detection of any integration issues, providing assurance to partners that the api is working as expected, and for paccurate, it ensures the technical soundness of the integration important make sure your api requests are sent as post and include the following headers key value content type application/json authorization apikey \[your api key] 6\ confirm the request within paccurate login to http //manage paccurate io , click on your key and confirm the request is logged properly verifying that the test request is recorded in the paccurate request log is an essential confirmation step it provides assurance that the api call was successfully received and logged by paccurate's system — this confirmation gives partners peace of mind that the api is functioning correctly, and it enables paccurate to monitor api usage and efficiently troubleshoot any potential issues 7\ connect user configurable data after a successful request to paccurate, move forward with connecting user configurable fields to the middleware api key, resources list, and api url connecting user configurable fields, such as the api key, api url, and resource list (or config text area) to the middleware is important for enabling flexibility and customization within the integration this step allows different customers to tailor the paccurate integration to their specific needs and configurations this configurability is a significant advantage for partners, as it enables them to create a scalable and adaptable integration including the ability to add custom configuration with rules or settings future proofs the customer as their cartonization requirements evolve over time 8\ send customers to paccurate for account creation & information direct customers to sign up for paccurate and create an api key at http //manage paccurate io customer specific keys are required for authentication and usage tracking this is important because it allows customers to gain access to paccurate's platform and cartonization capabilities, while also enabling paccurate to properly manage accounts and billing 9\ capture customer’s api key in client system store the customer’s api key in client system (and if applicable, custom url as provide to customer by paccurate) capturing the customer's api key and any custom url provided by paccurate within the partner's system is essential for enabling authorized api calls on behalf of the customer this step is important because this information is required for the partner's middleware to interact with the paccurate api this is crucial for partners as it allows for the seamless execution of api calls within their system, and ensures secure and authenticated paccurate api usage 10\ call middleware with your configuration with customer’s data properly configured and stored, make a call to the api with the middleware implementing the logic to call the middleware using the customer's specific configuration, including their api key, is the step that connects all the integrated components this is important because it enables the partner's system to dynamically utilize paccurate for various customers this dynamic capability is essential for partners, as it allows for a fully automated cartonization process it also results in cartonization being seamlessly integrated into the customer's workflow for paccurate, this step drives platform usage and highlights the value of its services 11\ confirm your api activity in paccurate dashboard direct customers to login to http //manage paccurate io and view their api activity, confirming that orders are being sent and associated with client system records via orderid or requestid it's important for customers to verify that their api activity is visible in their paccurate dashboard this step provides transparency and confirms that the integration has been configured correctly from the customer’s perspective this verification process is beneficial for partners as it builds trust and ensures customer satisfaction, and it gives customers peace of mind, knowing that their cartonization activity is being accurately tracked this should be the final validation step in the customer’s paccurate onboarding process