Getting Started with the VivoKey Developer API

Are you a developer looking to integrate VivoKey technology into your applications? The VivoKey Developer API offers a powerful way to authenticate components and products using NFC (Near Field Communication). Here’s a step-by-step guide to help you get started:

1. Understanding the API

The VivoKey API allows applications to verify the authenticity of VivoKey-enabled products using cryptographic proofs1. There are two main flows: Challenge/Response and Signature1. The Challenge/Response flow is the most secure method, where a cryptographic challenge is sent to the VivoKey product, and a secure response is generated1.

2. Setting Up Your Environment

Before you start, ensure you have the necessary tools:

• A development environment (e.g., Node.js, Python)
• An NFC reader to interact with VivoKey products
• Access to the VivoKey API (you may need to sign up for an API key)

3. Making API Requests

To make API requests, you’ll need to authenticate your application1. This typically involves obtaining an access token using OAuth 2.02. Once you have the token, you can make authenticated requests to the API endpoints.

4. Challenge/Response Flow

Here’s a basic example of how to implement the Challenge/Response flow:

1. Obtain a Challenge: Send a request to the VivoKey API to get a cryptographic challenge1.
2. Send Challenge to VivoKey: Use your NFC reader to send the challenge to the VivoKey product.
3. Receive Response: The VivoKey product will generate a secure response.
4. Validate Response: Send the response back to the VivoKey API for validation1.

5. Signature Flow

For the Signature flow, the process is similar, but instead of a challenge, you’ll use a signature to verify authenticity.

6. Handling Responses

Once the API validates the response, it will return a signed JSON Web Token (JWT) called an authenticity token. This token can be used to verify the authenticity of the VivoKey product in your application.

7. Example Code

Here’s a simple example in Node.js:

const axios = require('axios');
const nfc = require('nfc');

async function getChallenge() {
    const response = await axios.get('https://api.vivokey.com/challenge');
    return response.data.challenge;
}

async function validateResponse(challenge, response) {
    const response = await axios.post('https://api.vivokey.com/validate', {
        challenge,
        response
    });
    return response.data.authenticityToken;
}

nfc.on('tag', async (tag) => {
    const challenge = await getChallenge();
    const response = await nfc.sendChallenge(challenge);
    const token = await validateResponse(challenge, response);
    console.log('Authenticity Token:', token);
});

Conclusion

Integrating the VivoKey Developer API into your application can enhance the security and authenticity of your products. By following these steps, you can ensure a seamless and secure authentication process. Happy hacking!

‍

VivoKey Developer Portal