Başlarken

OneEntry Platform SDK, OneEntry Platform API ile etkileşim kurmanın kolay bir yolunu sağlayan bir SDK'dır.

Resmi Site

OneEntry Platform hakkında daha fazla bilgi edinmek için resmi OneEntry web sitesini https://oneentry.cloud ziyaret edin.

Kayıt Ol

OneEntry ile başlamanız için https://account.oneentry.cloud/authentication/register adresinden bir hesap oluşturun.

Kurulum

OneEntry Platform SDK'yı projenize kurmak için aşağıdaki komutu çalıştırın:

npm install oneentry

OneEntry Platform SDK'yı projenizde kullanmak için defineOneEntry fonksiyonunu içe aktarın:

import { defineOneEntry } from 'oneentry'
const config = {token: 'your-app-token',}const {Admins,AttributesSets,AuthProvider,Blocks,Events,FileUploading,Forms,FormData,GeneralTypes,ImmutableSettings,IntegrationCollections,Locales,Menus,Orders,Pages,Payments,ProductStatuses,Products,Settings,System,Templates,TemplatePreviews,Users,WS} = defineOneEntry('your-url', config);

Ya da

const config = {
  token: 'your-app-token',
};

const api = defineOneEntry('your-url', config);

---

Konfigürasyon

Yapıcının ikinci parametresi 'config' alır. Aşağıdaki değerleri içerir:

• 'token' - Projeniz için "Güvenlik API Token" anahtarını ayarlayın. Sertifika koruması kullanıyorsanız, bu değişkeni geçmeyin. Projenizin güvenliği hakkında daha fazla bilgi için buraya göz atabilirsiniz.
• 'langCode' - Varsayılan dili ayarlamak için "langCode" değerini belirleyin. Bu parametreyi bir kez belirterek, ONEENTRY API yöntemlerine langCode geçmek zorunda kalmazsınız. Varsayılan dili geçmediyseniz, "en_US" olarak ayarlanacaktır.
• 'traficLimit' - Bazı yöntemler, aldığınız verilerin eksiksiz ve çalışması kolay olması için OneEntry'ye birden fazla istek kullanır. Bu parametre için "true" değerini geçerek trafiği tasarruf edebilir ve hangi verilere ihtiyacınız olduğunu kendiniz belirleyebilirsiniz. Varsayılan değer "false"dur.
• 'auth' - Yetkilendirme ayarlarıyla bir nesne. Varsayılan olarak, SDK, kullanıcının oturumundaki tokenlarla çalışacak şekilde yapılandırılmıştır ve sizden ek bir işlem gerektirmez. Aynı zamanda, SDK oturumlar arasında oturum durumunu saklamaz. Bu ayarlarla memnunsanız, 'auth' değişkenini hiç geçmeyin.

'auth' aşağıdaki ayarları içerir:

• 'refreshToken' - Kullanıcının yenileme tokenı. Kullanıcının oturumunu başlatma sırasında buradan aktarın.
• 'saveFunction' - Yenileme tokenını güncelleyen bir fonksiyon. Tokenı oturumlar arasında saklamak istiyorsanız, örneğin yerel depolamada, bunu yapan bir fonksiyonu buraya geçin. Fonksiyon, token ile birlikte geçilecek bir parametre almalıdır.
• 'customAuth' - Yetkilendirmeyi kendiniz yapılandırmak ve tokenlarla çalışmak istiyorsanız, bu bayrağı true olarak ayarlayın. SDK ayarlarını kullanmak istiyorsanız, false olarak ayarlayın veya hiç geçmeyin.

Token koruması ve oturumlar arasında durumu saklayan otomatik kimlik doğrulama ile bir yapılandırma örneği

const tokenFunction = (token) => {
  localStorage.setItem('refreshToken', token);
};

const api = defineOneEntry('https://my-project.oneentry.cloud', {
  token: 'my-token',
  langCode: 'en_US',
  auth: {
    refreshToken: localStorage.getItem('refreshToken'),
    saveFunction: tokenFunction,
  },
});

Sertifika ile korunan ve yetkilendirme sistemini kendiniz yapılandırmanıza olanak tanıyan bir yapılandırma örneği

const api = defineOneEntry('https://my-project.oneentry.cloud', {
  langCode: 'en_US',
  traficLimit: true,
  auth: {
    customAuth: true,
    refreshToken: localStorage.getItem('refreshToken'),
  },
});

Tokenları kendiniz yapılandırmayı seçtiyseniz, tokenı yönteme aşağıdaki gibi geçebilirsiniz. Ara yöntem, isteğe bir erişim tokenı geçirmenizi sağlar. Ardından gerekli yöntemi çağırın. Bu yöntem (setAccessToken), kullanıcı kimlik doğrulaması gerektirmeyen bir yöntem çağrılmadığında çağrılmamalıdır.

const user = api.Users.setAccessToken('my.access.token').getUser();

Bağlantı güvenliğini sağlamak için token korumasını seçtiyseniz, tokenınızı isteğe bağlı bir parametre olarak fonksiyona geçin.

Tokenı aşağıdaki gibi alabilirsiniz

1. Kişisel hesabınıza giriş yapın
2. "Projeler" sekmesine gidin ve bir proje seçin
3. "Erişim" sekmesine gidin
4. "Güvenlik API Token" anahtarını ayarlayın
5. Projeye giriş yapın, ayarlar bölümüne gidin ve token sekmesini açın
6. Projenizin tokenını alın ve kopyalayın

Projenizi korumak için bir tls sertifikası da bağlayabilirsiniz. Bu durumda, "token"ı hiç geçmeyin. Sertifika kullanırken, projenizde bir proxy ayarlayın. URL parametresi olarak boş bir dize geçin. Güvenlik hakkında daha fazla bilgi edinin

const saveTokenFromLocalStorage = (token) => {
  localStorage.setItem('refreshToken', token);
};

const api = defineOneEntry('your-url', {
  token: 'my-token',
  langCode: 'my-langCode',
  auth: {
    customAuth: false,
    userToken: 'rerfesh.token',
    saveFunction: saveTokenFromLocalStorage,
  },
});

Hatalar

Eğer sc içinde hatalardan kaçınmak istiyorsanız, "errors" özelliğini varsayılan olarak bırakın. Bu durumda, ya varlık verilerini ya da hata nesnesini alırsınız. Bir tür kontrolü yapmanız gerekir. Örneğin, statusCode özelliğini ".hasOwnProperty" ile kontrol ederek.

Ancak, "try catch(e) " yapısını kullanmak istiyorsanız, "isShell" özelliğini "false" değerine ayarlayın. Bu durumda, hatayı "try catch(e) " ile ele almanız gerekir.

Ayrıca, SDK içinde uygun hata koduyla çağrılacak özel fonksiyonlar geçebilirsiniz. Bu fonksiyonlar bir hata nesnesini argüman olarak alır. Kendiniz işleyebilirsiniz.

const api = defineOneEntry('your-url', {
  token: 'my-token',
  langCode: 'my-langCode',
  errors: {
    isShell: false,
    customErrors: {
      400: (error) => console.error(error.message),
      404: (error) => console.error(error.message),
      500: (error) => console.error(error.message),
    },
  },
});

---