Trace Knowledge Center

API Documentation

GitHub

Support

API Update User endpoint allows you to update user information by making a PATCH request with the user's unique identifier (hashid). This endpoint enables you to modify specific user details, such as name, email, date of birth, phone number, and more.

Update User Information

Update User Endpoint

A simple ViewSet for viewing and editing accounts.

Bearer

A hub for learning and mastering Trace. Access guides, references, and resources designed to help you discover and build with Trace.

Our organization utilizes a comprehensive suite of tools to streamline workflows, enhance productivity, and ensure the delivery of high-quality projects. Each tool serves a specific purpose, and together, they enable us to manage every aspect of our operations efficiently. Below is a detailed overview of the tools we use, categorized by their primary function, along with descriptions of their features and benefits.

Toolbox

How login to Trace

Dashboard

Company profile

Connections

Requests

Transactions

Stock

Claims

Export tables

Sync data

Install & Update

Login

Buy products

Sell option

Onboarding Farmers

User Profile

Clear data and logout

View / Print Invoice

Data Migration

More features

Trace -Storytelling Interface

Navigate

Trace Connect

Sync logic

Google Analytics integrated within the Trace Mobile App allows for the collection of data, enabling the creation of reports that showcase user interaction with the app.

App packages

Google Analytics - Trace Mobile App

All the authentication and initial details fetch APIs are included in this section.

Authentication

Dashboard will help Trace partners will be able to gain a better understanding of the farmers and businesses involved in their food chain, track the current location of products, and assess how well brand commitments are being fulfilled.

Trace Dashboard Release Notes

Mobile App Release Notes

Storytelling Release Notes

Farmer card

The first quarter of 2023 has been a whirlwind of activity for our development team! In just three months, we managed to ship an impressive 493 tickets to production across six sprints and six releases. Our team has been tackling a variety of tasks, from designing and updating pages to squashing bugs. Keep reading for a rundown of the exciting developments from the first quarter of the year.

Trace Tech: 2023 Q1 Highlights



Q2 burst with energy as our Tech team rallied together in early May,  igniting a dynamic spark. We fearlessly explored our tech archives, reviving forgotten treasures with a modern touch.

Trace Tech: 2023 Q2 Highlights



During Q3, we shifted our gears into high gear for open-source-ready!  We rolled up our sleeves, kicked off some epic housekeeping, and gave our tech a major upgrade. Additionally, we introduced some impressive new features. Perhaps the most thrilling accomplishment was the successful launch of a fully traceable nutmeg chain, complete with a captivating story curated by Trace, which is now available in supermarkets

Trace Tech: 2023 Q3 Highlights

Trace Tech: 2023 Q4 Highlights

Brand

Foundations

Connect app Privacy Policy

Introduction

Trace Connect Server

The JWT Authentication endpoint enables users to obtain JSON Web Tokens (JWT) for secure authentication. Upon successful login, the API provides both an access token and a refresh token encoded as JWTs, allowing authenticated access to protected resources and token renewal for prolonged usage.

Obtain JWT Token for Secure Access

Login Endpoint

The Token Refresh endpoint allows users to refresh JSON Web Tokens (JWT) seamlessly. By providing a valid refresh token, users can obtain new JWT tokens, ensuring uninterrupted access to protected resources.

Refresh JWT Tokens for Continuous Access

Refresh Token Endpoint

Logout endpoint is used to terminate a user session against a device, effectively logging the user out. By making a POST request to this endpoint and providing the necessary authorization, the user's session will be ended, ensuring secure access control.

Terminate User Session

Logout Endpoint

Trace Connect OAuth 2.0 provider

Get Company Details endpoint allows you to retrieve detailed information about a specific company within the supply chain by making a GET request. Provide the hash ID of the company in the endpoint URL.

Retrieve Company Details

Company Details Endpoint

This API endpoint allows you to retrieve a list of farmers within the supply chain system. By sending a GET request to the specified endpoint, you can obtain information about multiple farmer submissions. The API supports secure authentication through an API key included in the request header.

Retrieve Farmers

List Farmers Endpoint

This API endpoint allows you to seamlessly integrate and create a new submission for farmers within the supply chain system. Through this endpoint, you can capture essential information about farmers, including entity card details, form submissions, contact information, and additional demographic data.

Create a Farmer

Create Farmer Endpoint

Products endpoint allows you to retrieve a list of products connected with the active company. A GET request to this endpoint, along with the necessary authorization, returns a paginated list of products with details such as product ID, creation/update timestamps, name, and other relevant information.

Retrieve Products

List Products Endpoint

This API endpoint allows you to create a product transaction within the supply chain system. By sending a POST request to the specified endpoint, you can initiate a product transaction, including transaction payments and submission details.

Make a Transaction

Create Product Transaction Endpoint

This endpoint allows you to retrieve a list of product transactions. Each transaction includes details such as transaction payments, amount, currency, type, source and current quantity, submissions, card details, currency details, and additional information. The API response provides a paginated list of transactions with a count, next, previous, and an array of transaction results.

Trace Connect APIs

Update User Endpoint

Authorizations

Path Parameters

Body

Response