Abyss Storage
  • Abyss Storage
  • Setup
    • Core
    • File Management
    • Webhook
    • Thumbnails
    • Bucket
    • Collection
  • About
    • Links
Powered by GitBook
On this page
  • Using the NPM Core Package
  • Standalone
  1. Setup

Core

PreviousAbyss StorageNextFile Management

Last updated 8 months ago

Using the NPM Core Package

The Core setup will allow you to use the core methods to access the service API.

AbyssStorageCore.setConfig({
  // Your Application Storage API Key
  applicationApiKey: "application-storage-api-key",
  // Your Application ID
  userApplicationId: "user-application-id",
});
// This method will enable automatic retry on failed http request to AbyssStorage API
AbyssStorageCore.enableAxiosRetry();

Standalone

If you are not using the to access the API, you can skip this step and just set your API key on the HTTP request header.

// HTTP Version
GET /api/user/me HTTP/1.1
Host: storage-api.abyss-project.fr
abyss-storage-api-key-application: "abyss-storage-api-key-application"

// Curl Version
curl --location 'https://storage-api.abyss-project.fr/api/user/me' \
--header 'abyss-storage-api-key-user-application: abyss-storage-api-key-user-application'

abyss-storage-api-key-application: allow you to access application endpoint

NPM package
How to create an API Key ?