The official Strapi SDK for JavaScript, available for browsers or Node.js backends.

Install

npm install strapi-sdk-javascript

Start now

New instance

importStrapifrom'strapi-sdk-javascript';conststrapi=newStrapi('http://localhost:1337');

Authentications

Local

awaitstrapi.login('username_or_email','s3cr3t');

Providers

// Redirect your user to the provider's authentication page.window.location=strapi.getProviderAuthenticationUrl('facebook');

// Complete the authentication: (The SDK will store the access token for you)awaitstrapi.authenticateProvider('facebook');

constposts=awaitstrapi.getEntries('posts');

Files management

Browser

constform=newFormData();form.append('files',fileInputElement.files[0],'file-name.ext');form.append('files',fileInputElement.files[1],'file-2-name.ext');constfiles=awaitstrapi.upload(form);

Node.js

constFormData=require('form-data');constfs=require('fs');constform=newFormData();form.append('files',fs.createReadStream('./file-name.ext'),'file-name.ext');constfiles=awaitstrapi.upload(form,{headers:form.getHeaders()});

API

Strapi(baseURL, storeConfig, requestConfig)

request(method, url, requestConfig)

register(username, email, password)

login(identifier, password)

forgotPassword(email, url)

resetPassword(code, password, passwordConfirmation)

getProviderAuthenticationUrl(provider)

authenticateProvider(provider, params)

setToken(token, comesFromStorage)

clearToken(token)

getEntries(contentTypePluralized, params)

getEntry(contentTypePluralized, id)

getEntryCount(contentTypePluralized, params)

createEntry(contentTypePluralized, data)

updateEntry(contentTypePluralized, id, data)

deleteEntry(contentTypePluralized, id)

searchFiles(query)

getFiles(params)

getFile(id)

upload(data)

requestConfig

Resources

Roadmap

Credits

License