Skip to main content

API v0 to v1 Migration Guide

Item Format Changes​

Modified Item Fields​

For all routes, the following item fields have been renamed:

  • The field text_fields.sku has been renamed to text_fields.order_id.
  • The key authentication_id has been renamed to entrupy_id.
  • The key authenticator has been renamed to owner.

New Item Fields​

All items will now have the activity key.

The possible keys inside the activity dict are:

  • name: values: "authentication" or "fingerprint".
  • mode -
    • For "authentication" items mode will not be set.
    • For "fingerprint" items mode is one of "compare" or "register".

Modified Routes​

Retrieve Authentication Sessions by Entrupy ID​

GET /v1/authentications/{entrupy_id}

In v0, the fields in the item this route returns were all top level keys. Now all data from the item has been moved into the item field, to allow for returning additional metadata and warnings.

Example v0 result:

{
  "authentication_id": "1SALEFYH",
  "authenticator": {
    "organization": {
      "name": "EntrupyOrganization"
    },
    "user": {
      "username": "EntrupyUser"
    }
  },
  "certificate": {
    "preview": "https://cert.entrupy.com/1SALEFYH",
    "site": "https://cert.entrupy.com/1SALEFYH"
  },
  "properties": {
    "brand": {
      "id": "louis_vuitton"
    },
    "model": {
      "id": "damier_azur_canvas"
    }
  },
  "status": {
    "flag": null,
    "result": {
      "final": true,
      "id": "authentic"
    }
  },
  "text_fields": {
    "date_code": "9970303",
    "sku": "8492068"
  },
  "timestamp": {
    "display": "2019-08-27T00:14:28.342735Z",
    "epoch": 1566879268.342735
  }
}

Example v1 result:

{
  "item": {
    "activity": {
      "name": "authentication"
    },
    "certificate": {
      "preview": "https://cert.entrupy.com/1SALEFYH",
      "site": "https://cert.entrupy.com/1SALEFYH"
    },
    "entrupy_id": "1SALEFYH",
    "owner": {
      "organization": {
        "name": "EntrupyOrganization"
      },
      "user": {
        "username": "EntrupyUser"
      }
    },
    "properties": {
      "brand": {
        "id": "louis_vuitton"
      },
      "model": {
        "id": "damier_azur_canvas"
      }
    },
    "status": {
      "flag": null,
      "result": {
        "final": true,
        "id": "authentic"
      }
    },
    "text_fields": {
      "date_code": "9970303",
      "order_id": "8492068"
    },
    "timestamp": {
      "display": "2019-08-27T00:14:28.342735Z",
      "epoch": 1566879268.342735
    }
  }
}

Retrieve Authentication Sessions by Field (Order ID/SKU)​

GET /v1/lookup/authentications/{lookup_value}

In v0, the fields in the item this route returns were all top level keys. Now all data from the item has been moved into the item field, to allow for returning additional metadata and warnings. See the example under "Retrieve Authentication Sessions by Entrupy ID".

Search Authentication Sessions​

POST /v1/search/authentications

Each item inside the items field which is returned has the same fields renamed or added in accordance with the Item Format Changes section above.

Due to the field rename in all items, previous searches for text_fields.sku now must use text_fields.order_id.

Example v0 result:

{
  "item_count": 1,
  "items": [
    {
      "authentication_id": "E5F1LFYN",
      "authenticator": {
        "organization": {
          "name": "EntrupyOrganization"
        },
        "user": {
          "username": "EntrupyUser"
        }
      },
      "certificate": {
        "preview": "https://cert.entrupy.com/E5F1LFYN",
        "site": "https://cert.entrupy.com/E5F1LFYN"
      },
      "properties": {
        "brand": {
          "id": "gucci"
        },
        "model": {
          "id": "gg_canvas"
        }
      },
      "status": {
        "flag": null,
        "result": {
          "final": true,
          "id": "authentic"
        }
      },
      "text_fields": {
        "serial_number": "8529268",
        "sku": "5416322"
      },
      "timestamp": {
        "display": "2019-08-19T13:38:54.083790Z",
        "epoch": 1566236334.08379
      }
    }
  ],
  "next_cursor": null
}

Example v1 result:

{
  "item_count": 1,
  "items": [
    {
      "activity": {
        "name": "authentication"
      },
      "certificate": {
        "preview": "https://cert.entrupy.com/E5F1LFYN",
        "site": "https://cert.entrupy.com/E5F1LFYN"
      },
      "entrupy_id": "E5F1LFYN",
      "owner": {
        "organization": {
          "name": "EntrupyOrganization"
        },
        "user": {
          "username": "EntrupyUser"
        }
      },
      "properties": {
        "brand": {
          "id": "gucci"
        },
        "model": {
          "id": "gg_canvas"
        }
      },
      "status": {
        "flag": null,
        "result": {
          "final": true,
          "id": "authentic"
        }
      },
      "text_fields": {
        "order_id": "5416322",
        "serial_number": "8529268"
      },
      "timestamp": {
        "display": "2019-08-19T13:38:54.083790Z",
        "epoch": 1566236334.08379
      }
    }
  ],
  "next_cursor": null
}