This guide will help you make your first API call to Skyflow. You'll do this through Postman or using manual cURL requests. By the end of this guide, you’ll have used the Skyflow API to insert and retrieve sensitive data from a vault.
Before you start,
This guide will use the Quickstart vault to show you how to insert and retrieve data from a Skyflow vault.
To start, we’ll insert some fake data into the vault using the Insert Record API. The guide below explains how to do this using the Postman Collection or with a manual cURL request.
Follow the instructions below to use Postman to submit the Insert Record API.
Click the arrow beside your collection name to expand it, then click Data APIs > credit cards CRUD APIs > insert credit_cards as shown below.
Click the Body tab on the right, and fill in some sample data to insert into the vault (including a card number, name, expiration month, and expiration year). Then click Send.
skyflow_id gets returned. This is a unique ID created for the record that you just inserted. Copy it for the next step.
To read data from the vault, use the Get Record API in Postman, or enter a manual cURL request.
Follow the instructions below to use Postman to submit the Get Record API.
Click get credit_cards.
In the Params tab on the right, paste the skyflow_id into the Value column as shown below.
Click Save, and then click Send.
Skyflow applies dynamic data redaction whenever data is retrieved from a vault. Data can be returned in one of the following redaction formats:
The value will be fully redacted in the response.
“John Doe” → “REDACTED”
The value will be partially redacted (masked) in the response. The masking format for a given data field is configured in the vault schema.
“4111111111111111” → “****1111
The value will be returned in plain text in the response.
“11/25” → “11/25”
The value will be redacted using the default redaction format defined in the vault schema. Fields may have different default redaction formats.
To redact the data, use the Get Record API in Postman, or enter a manual cURL request.
In Postman, enter DEFAULT into the redaction Value column and click Save.
You should get back a response that looks similar to the one below:
Notice the field redaction levels.
card_numberfield is masked so that only the last 4 digits are visible.The
cardholder_namefield is fully redacted.The
expiry_dateis returned in plain text.
These defaults are configured in the vault schema. You can learn more about this in the the Create a vault guide for creating a custom vault.
Send the same request but this time, enter PLAIN_TEXT into the redaction Value column and click Save.
You’ll get back a response like the following:
Congratulations! You’re ready to start storing sensitive data in a secure vault!
As next steps, check out the other Data APIs or one of the articles below:
In this article
© 2022 Skyflow, Inc. All rights reserved.
Terms and Conditions