Getting Started

A few things to get you started

Connect your wallet to ORB

The first step is to connect to ORB using your wallet. If you are connecting as a developer, the wallet with which you will connect to the platform, is the wallet which will be used to manage your projects and assets.

ORB supports all Tezos supported wallets. In this documentation we will be using Temple wallet, throughout all of our examples. Before moving ahead, make sure you have Temple wallet, or the wallet of your preference, installed in your mobile device.

Generating a QR code

Use the following mutation to generate a QR code and connect your wallet to ORB.

CreateWalletSyncQRCodeSession

mutation CreateWalletSyncQRCodeSession() {
  CreateWalletSyncQRCodeSession() {
    base64Image
    sessionId
  }
}

Response

{
  "data": {
    "CreateWalletSyncQRCodeSession": {
      "base64Image": "iVBORw0KGgoAAAANSUhEUgAAAVQAAAFUCAYAAAB7ksS1AAAcE0lEQVR4AezBQY4YybLgQDJR978yR0tfBRDILLXefDezP1hrrfXaw1prrU88rLXW+sTDWmutTzystdb6xMNaa61PPKy11vrEw1prrU88rLXW+sTDWmutTzystdb6xMNaa61PPKy11vrEw1prrU88rLXW+sTDWmutT/zwksrfVHGiclJxonJSMancqDhRmSpOVE4qTlTeqJhUTipuqHypYlK5UfGGyknFDZWp4kRlqjhRmSomlZOKN1T+poo3HtZaa33iYa211ice1lprfeKHj1V8SeVGxaQyqXyp4obKVDFVnKi8oTJV/KaKSWWqmFSmiknlRsWNihOVqWJSmSpuqEwVJxWTylRxojJV3Kg4UZkqJpWp4qTiSypfelhrrfWJh7XWWp94WGut9YkffpnKjYr/UsWkMqm8UTGpTBWTylTxRsWk8qWKk4qTiknlpGJSuVFxo+KkYlI5qbihckNlqphUJpUvVfwmlRsVv+lhrbXWJx7WWmt94mGttdYnfvj/jMpUcaIyqUwVk8qNipOKGyq/qeJEZao4UTmpmFSmihsVv0llqnhD5aTipGJSmSomlZOKE5WpYlKZKv4veVhrrfWJh7XWWp94WGut9Ykf/o9RmSomlUllqjhROVG5UXGi8iWVk4oTlaliUplUpopJZao4UblRMancULlRMalMFW9UnFScqEwVU8UNlf9LHtZaa33iYa211ice1lprfeKHX1bxm1RuVLyhclIxqfxNFTdUTiomlanib1K5UTGpTCo3Km6oTConKm+onFRMKlPFpDJVnFRMKlPFlyr+JQ9rrbU+8bDWWusTD2uttT7xw8dU/ksVk8pUMalMFZPKVDGp3KiYVKaKSWWquKEyVZxUTCpTxaQyVUwqU8WkcqNiUpkqJpWpYlKZKiaVE5Wp4qRiUpkqJpWpYlKZKiaV36QyVdxQmSpOVP5lD2uttT7xsNZa6xMPa621PvHDSxX/pYpJZaq4oTJVnFRMKlPFpHKjYlK5UXFD5Q2Vv6liUjlRmSomlRsV/0tUpoobKlPFScVJxUnF/5KHtdZan3hYa631iYe11lqf+OEllaniRGWqmFROKiaVqeJGxaRyQ+VGxaQyqUwVU8WkMqm8UTGpTCpTxaTyhsqJyknFGxWTyqTyL6k4qZhU3qg4UflSxaQyVfxLHtZaa33iYa211ice1lprfcL+4EMqU8WkclJxQ+Wk4kTlpOKGylRxojJV/CaVk4obKicVk8pU8SWVqeKGylQxqfxNFTdUblRMKjcqJpWpYlJ5o2JSmSomlRsVbzystdb6xMNaa61PPKy11vqE/cFfpDJVTCpfqphUpooTlaniROWk4kTlpGJSOam4ofKlihsqU8WkMlVMKlPFpHJSMalMFZPKVDGpTBWTylRxojJVnKhMFW+onFS8oTJVTCpTxaQyVUwqU8WXHtZaa33iYa211ice1lprfeKHl1RuVNyoOFGZKiaVGypTxRsVJyonFTcqvlTxJZUbKlPFpHKjYlK5oXKiMlWcVEwqU8VUcaIyVZyoTBUnFZPKDZWpYqqYVKaKk4pJZaqYVKaKNx7WWmt94mGttdYnHtZaa33C/uAFlZOKE5UvVUwqU8Wk8kbFDZWTihOVqWJSmSq+pPJGxaQyVdxQ+ZsqbqhMFTdUpopJZaq4oTJVTCpTxYnKjYpJ5b9U8cbDWmutTzystdb6xMNaa61P2B/8IpWp4g2VqeJE5aTiDZUbFTdUpopJ5aRiUjmpuKEyVUwqJxWTylRxojJVnKi8UXFDZaqYVH5Txd+kMlWcqEwVN1ROKiaVqeJLD2uttT7xsNZa6xMPa621PvHDx1RuqNyoOFE5qZhUTiomlf+SylRxojJV3FCZKqaKGxWTyonKVHGiMlWcVEwqU8WkclIxVdyoeEPlRGWqmFRuVHxJ5UbFpDKpnKhMFW88rLXW+sTDWmutTzystdb6xA//sYpJZaqYVKaKqeKNijcqTlSmiknlN6ncqJhUpoq/SeWk4obKVDGp3FD5m1SmipOKSeVLFScqNypuVJyoTBVfelhrrfWJh7XWWp94WGut9Qn7gw+pvFExqUwVk8pUMalMFZPKVDGpTBVfUrlRMalMFTdUblRMKicVJypTxYnKVPGGyo2KSWWqeEPlRsWkclIxqUwVN1ROKk5Upoo3VKaKE5Wp4o2HtdZan3hYa631iYe11lqf+OFjFZPKVDGpTCpTxUnFpHKj4qTihsqNin9JxYnKVDGp3KiYVG6onFRMKlPFl1ROKk4qJpWp4ksVk8pUMalMFZPKicoNlZOKGyq/6WGttdYnHtZaa33iYa211ifsDz6kclIxqdyoOFG5UTGpfKniROVGxYnKb6o4UZkqJpUbFZPKb6p4Q2WqmFT+popJZar4l6mcVNxQOal442GttdYnHtZaa33iYa211id+eEllqphUblScqEwVU8WJyqQyVUwqJxUnKicVk8p/qeKGylQxqZxUTConFZPKScWkcqJyo+KNiknlpGJSOVE5UZkqbqhMFTdUblScqEwVf9PDWmutTzystdb6xMNaa61P/PDLKk4qJpUbKlPFScWkMqlMFb9JZaqYVL5UMancUJkqJpWp4kTlROU3VdxQOak4qZhUpopJ5UbFicpU8ZtUTipuqEwVU8VJxaTypYe11lqfeFhrrfWJh7XWWp+wP3hB5aTiSyo3Kr6kMlX8TSpTxYnKScUNlZOKE5Wp4l+iMlVMKjcqJpUbFTdUpoobKicVk8pJxaTyRsWXVKaKNx7WWmt94mGttdYnHtZaa33C/uBDKjcqTlSmikllqphUflPFicpJxRsqJxUnKjcqJpWTihOVk4oTlb+pYlKZKm6oTBU3VG5UTCpTxaRyUjGp3KiYVKaKSWWquKEyVXzpYa211ice1lprfeJhrbXWJ354SWWqOFGZVKaKqeKNijdUpooTlZOKSeWkYlK5oTJVTBUnKpPKf0llqphUpoobKlPFpHKiMlWcVJyonFRMKlPFpHKj4kRlqjhRuaHyhsrf9LDWWusTD2uttT7xsNZa6xP2By+oTBUnKv+lijdUblTcUJkqTlT+SxWTylQxqZxUnKicVEwqU8Wk8jdVnKicVEwqU8WkMlWcqEwVJyr/sopJ5aTijYe11lqfeFhrrfWJh7XWWp/44aWKSeWkYlKZKm6oTBU3VKaKk4pJ5YbKVHGicqPihspUcUNlqphUbqhMFVPFjYpJ5aRiUpkqbqhMKr9J5TepTBWTyhsVN1SmipOKSeVLD2uttT7xsNZa6xMPa621PvHDSyonFW+oTBX/S1RuVEwqU8WkcqIyVZyovKHyRsXfVDGp3FCZKt6oeKPiRGWqmComlaniRsWJyonKVPGGym96WGut9YmHtdZan3hYa631iR9eqjhReaPihspUMalMFZPKScVUMan8JpUbFTcq3lCZKk5U3lCZKk4qJpU3Km5UnKj8popJ5aTiROVEZaq4UfGliknlSw9rrbU+8bDWWusTD2uttT5hf/CCylRxovI3VdxQuVExqUwVk8r/kooTlaliUpkqJpWpYlKZKm6o/EsqTlSmiknlpOINlaniRGWquKHyN1X8poe11lqfeFhrrfWJh7XWWp/44WMqU8VU8ZtUvlRxonKiclIxqUwVb6hMFScqX6qYVKaKGypTxaQyVZyo3KiYVG6oTBVTxUnFpDKpnFTcUJkq3lC5UXFD5YbKVPHGw1prrU88rLXW+sTDWmutT9gf/CKVGxWTylRxQ+VGxaRyUnFDZaq4oTJVnKhMFW+oTBVvqJxUnKhMFZPKVDGpTBWTyknFGyo3Kt5QuVFxQ+VGxRsqU8WkcqPijYe11lqfeFhrrfWJh7XWWp/44SWVk4pJ5URlqrihMlW8UXGiMlV8SeVEZao4UTmpuKEyVUwqJxUnKn+TylQxqUwqb1RMKjdUpopJZaqYVKaKSWWqmFRuVNxQuaEyVZyofOlhrbXWJx7WWmt94mGttdYnfviPVZyoTBWTylRxonJSMamcVJyonKhMFTcqblScqNyomFSmijcqJpUTlaliUpkqTlRuVJyoTConFScVk8pUMamcqEwVNypOVG5UnKhMFTcqvvSw1lrrEw9rrbU+8bDWWusT9gcfUrlRMalMFZPKlyomlaliUpkqvqQyVUwqU8UbKlPFDZWp4kTlpOJEZao4UZkqbqjcqJhUpopJ5UsVJypTxaRyUnGicqNiUrlRMalMFScqU8UbD2uttT7xsNZa6xMPa621PvHDL6uYVCaVqWJSOamYVKaKv0nljYo3VKaKSWWquKFyQ+WkYlKZKk5UpooTlZOKqeJEZVI5UZkqJpWpYlK5oTJV3KiYVKaKqeKGyknFjYoTlaniSw9rrbU+8bDWWusTD2uttT5hf/CCylTxhspUMalMFZPKScWXVKaKN1SmijdUvlTxN6lMFZPKVDGpTBU3VKaKSWWqOFE5qZhUpoo3VKaKSeWkYlKZKiaVGxU3VKaKSWWq+E0Pa621PvGw1lrrEw9rrbU+8cM/TmWquFExqUwVk8qXVE4qpooTlaliUrlR8YbKScWkclLxN6n8JpWp4kRlqjhRmSpOKiaVNyomld+kcqJyQ2WqeONhrbXWJx7WWmt94mGttdYn7A9eUDmpmFSmii+pnFRMKicVJyonFZPKVDGp3Kh4Q2WqmFSmikllqphU3qiYVKaKGypTxQ2Vk4oTlaliUrlRMalMFW+onFRMKlPFDZWTiknlpGJSOal442GttdYnHtZaa33iYa211id+eKliUplUpopJZaqYVKaKGxUnFTdUbqhMFScVk8obKlPFicqJylTxpYqTihOVqWKqOFGZKk4qTlSmiknlpGJS+U0qJxUnFScqU8VJxaTyL3tYa631iYe11lqfeFhrrfWJH/4xKlPFv6TiRGWqOFGZKqaKGypTxaQyVUwqJxWTylQxVbyhclLxhsqJyg2VE5WTihsqJypfUjmpmFSmijcqJpWp4qTiNz2stdb6xMNaa61PPKy11vrEDy+pTBWTyknFpDKpfEnlpOJEZao4UbmhMlVMKjdUpopJ5W9SuVExqUwqN1RuVJyo3Kg4UZkqpopJ5UbFicpJxaRyQ+WGyg2Vk4pJZap442GttdYnHtZaa33iYa211id+eKliUjlRmSpOKn5TxYnKVHFSMam8oTJVTCpTxaQyqUwVk8qNihsV/8tUblRMKl+qmFRuqNxQmSpOKiaVL1VMKicqv+lhrbXWJx7WWmt94mGttdYnfnhJ5Q2VqWJSuVExqUwVNypuqNyomFSmikllqvhSxaRyojJV3FCZKiaVk4obFScqNyq+VHGiMlVMFV+quKEyVZxU3FCZVP4lD2uttT7xsNZa6xMPa621PvHDX1YxqZxUnKhMKlPFpHJSMamcVJxUnKhMFScVX1L5TSonFScVX1L5TSo3KiaVqeKGyknFScWkMlWcVEwqU8UNlTcq/qaHtdZan3hYa631iYe11lqf+OGlihOVGyonFVPFicpUcaPiROWGylQxqUwVJyo3KiaVqeJEZaq4UTGpTBWTyo2Kk4oTlUllqphUTireUJkqJpWTiknlROWGyknFpHJScVIxqUwVJyonFW88rLXW+sTDWmutTzystdb6xA8vqUwVNyomlaliUpkqbqhMFScqU8VUcaNiUpkqJpWp4kbFpHJDZaq4UfFGxYnKpDJVvFExqUwVJypTxY2KN1ROKiaVGxWTyqQyVXypYlKZKv6mh7XWWp94WGut9YmHtdZan7A/+JDKScWk8psqJpUbFZPKVDGpTBUnKicVk8rfVDGp/KaKGyonFW+ofKniROVGxYnKVDGpTBU3VKaKGyq/qWJSmSq+9LDWWusTD2uttT7xsNZa6xM/vKRyUjGpnFTcUJkqJpWpYlKZKiaVN1SmiqniRGWqmFSmihsqJyonFScqb6jcqJhUblScVNxQmVTeqDhRmSpuqEwVk8oNlanipOKGylQxqfxND2uttT7xsNZa6xMPa621PvHDP05lqjhROVGZKr5U8YbKVPGGylRxUnGiMqlMFVPFicqXVG5UTCo3VKaKk4pJZar4TSonFScVk8qkMlVMKjdUpoobFX/Tw1prrU88rLXW+sTDWmutT/zwsYqTiknlpOI3qUwVN1ROKiaVqeJEZaq4UXFDZar4kspUMalMFZPKVPGGylQxqZxU3FA5UZkqJpU3KiaVv6liUjmpeENlqvhND2uttT7xsNZa6xMPa621PvHDSxVfUnmj4g2VqeJEZao4qTipmFQmlROVNyomlanihsqXKiaVqeJE5Q2VNypOVP6miknlpGKquKFyovI3qUwVbzystdb6xMNaa61PPKy11vrEDy+pnFScVLyh8ptUpoo3VKaKk4o3VE4qJpWpYlKZKiaVqWJSmVSmihOVNyomlRsVk8pJxY2KSWWqmFS+VDGpfKniROWk4kbFScWXHtZaa33iYa211ice1lprfeKHf4zKScVUcaIyVUwqU8WkMqn8JpWp4kTlpGJSuaEyVUwqv0nlpOJEZaq4UXFS8TepnFRMKlPFpPKGyknFpHKj4kRlqjhRmSq+9LDWWusTD2uttT7xsNZa6xM/vFQxqUwqU8WNiknlRsWkcqIyVUwqU8WJyr+k4qTiROWk4kbFb6o4qfiSyknFpDJVnFScqEwVJxWTylRxo+JGxaRyojJVTCpTxVQxqUwVbzystdb6xMNaa61PPKy11vqE/cELKjcqTlS+VDGpTBUnKl+qmFTeqJhUTiomld9U8SWVGxWTyknFpDJVnKi8UXFDZao4UZkqbqjcqLihcqNiUpkqTlSmijce1lprfeJhrbXWJx7WWmt9wv7gQypfqjhRmSpOVE4qbqhMFScqJxU3VG5UTCpTxYnKVHGiMlVMKlPFpDJVnKicVEwqJxWTyknFpDJVnKj8L6mYVE4qJpU3KiaVqWJSmSq+9LDWWusTD2uttT7xsNZa6xP2Bx9SeaNiUvlNFZPKVDGpTBWTyknFicpU8YbKScUNlaliUjmpmFROKiaVL1WcqJxUTConFScqU8WJyv+yiknljYobKlPFGw9rrbU+8bDWWusTD2uttT7xwy+rmFSmikllqphUblScqEwVk8pUMancUJkqporfVDGp3KiYVKaKE5WTipOKL6ncqJhUTip+U8WkMlWcqJxUnKjcqJhUpopJZao4UZkq/qaHtdZan3hYa631iYe11lqf+OEllaliUpkqbqhMFTdUTipOKiaVqeKGyonKVDGpTBWTylQxqUwVk8obKlPFVDGpTCpTxaQyVUwqU8WkclIxqfwmlaniROVLFZPKicpUcaIyqZyoTBWTylQxVZyoTBVfelhrrfWJh7XWWp94WGut9YkfPqYyVUwqU8VU8V9SmSpOVKaKSeUNlRsVN1ROKk4qJpVJ5UbFDZUbFTcq3lCZKk5UTipuqHypYlK5UTGpTBWTylRxQ2Wq+E0Pa621PvGw1lrrEw9rrbU+8cNfVnFDZao4UTmpmFSmijdUbqhMFScqk8pJxVQxqdxQOamYVP5LKjcqblRMKlPFScWkckPlpOI3VUwqU8VvUjmpOFGZKt54WGut9YmHtdZan3hYa631CfuDD6m8UXGi8jdVnKhMFZPKVHGiclJxQ+WkYlI5qZhUpopJ5Y2KE5Wp4obKjYoTlS9VnKi8UXGi8jdVvKEyVZyoTBVvPKy11vrEw1prrU88rLXW+sQPL6m8UTGpnFTcUDmpmFQmlaniRGWqmFSmipOKSWWqmFSmihOVqeJGxY2KE5UvqZxU3FD5UsWkcqLyRsWXKk5UpopJ5UTlpGKqOFH5TQ9rrbU+8bDWWusTD2uttT7xw8cqbqicVJyoTBUnFZPKVDGpnFRMKpPKlyomlTcqvqQyVXxJZao4qThROamYKiaVqeI3VUwqN1TeqDhRmSpOKiaVv6niSw9rrbU+8bDWWusTD2uttT7xw8dUpopJZaqYVCaVNyomlROVqWJSOamYVE5U3qg4UblRMam8oXKjYlK5oTJVTConFZPKVHGiMlWcqNxQuVFxovKGyg2VqeKk4obKVDFV/KaHtdZan3hYa631iYe11lqf+OGliknlpGJSOamYVKaKE5UbFScVb1RMKicqU8UbFScqJxWTylTxv0xlqjipmFQmlZOKE5WTikllUpkqblRMKlPFlyomlZOKqWJSmSomlanijYe11lqfeFhrrfWJh7XWWp/44R+nMlVMKm9UTCpTxaQyVZxUTCpTxZdUTlSmiqniSypTxaQyVZxUTCpTxRsVJypTxVRxonKiMlWcqJxUnFScqEwVk8qNihOVqWJSmVSmiqliUvlND2uttT7xsNZa6xMPa621PvHDxyreqLhRcaLypYpJZaq4oXJSMamcVNxQmSreUDlR+U0qJxWTyonKicpUcVIxqZyovKEyVUwqN1SmiknlN1VMKpPKVDFV/KaHtdZan3hYa631iYe11lqfsD/4kMobFZPKVHGi8kbFDZWp4obKScWJypcqTlSmikllqjhRmSomlRsVJypTxaTymypuqEwVJyo3Kt5QmSpOVP5lFW88rLXW+sTDWmutTzystdb6hP3B/zCVk4oTlaliUpkqTlSmiknlpOJE5aTihspUMamcVPyXVKaKE5WTikllqrihclIxqdyomFROKk5UTipOVE4qJpWp4obKVHGiclLxxsNaa61PPKy11vrEw1prrU/88JLK31QxVUwqk8oNlROVqWKqmFROKiaVk4pJ5URlqrhRMancUJkqJpWTipOKL6ncUJkqTiomlRsVk8pUMancqDhRmSpOKt5QmSpOVKaKk4ovPay11vrEw1prrU88rLXW+sQPH6v4ksqJylQxqZxUTCpTxQ2VGyonFW9U3FCZKm6oTBWTylQxqUwqJxVvVJyonFTcUJkqTlQmlaliUrmhclIxVUwqN1RuVNyomFROVKaKNx7WWmt94mGttdYnHtZaa33ih1+mcqPiRsWNii+p3Kg4UXlD5Y2KGyo3KiaVN1TeUJkqTlTeqHijYlKZKiaV/5LKVDGpTCpfqphUpoovPay11vrEw1prrU88rLXW+sQP/+NUpoqp4kRlqrhR8S+pmFTeUJkqTlQmlaliqphUpoobKlPFicqkcqNiUjlRuVExqUwVk8pUcaNiUnmjYlKZKr6kMlWcqEwVbzystdb6xMNaa61PPKy11vrED//jKiaVqeKkYlKZKk5UpopJZaqYVN6omFSmikllqphUTlSmipOKSeWGyknFVDGpnFRMKlPFicpUcUPlDZWpYlK5oXJSMancqLihMlVMKjcqJpUvPay11vrEw1prrU88rLXW+sQPv6zib6o4UZkqpoobFTdU3lCZKv5LKjcqJpWp4n+ZyhsVJxWTyqTym1RuqEwVk8pUcaPihspU8aWHtdZan3hYa631iYe11lqfsD94QeVvqphUpooTlf9SxaQyVZyovFFxQ2WqmFR+U8WkMlW8oTJVTCpTxYnKScUNlRsVk8pUMalMFTdUpoobKm9UnKicVHzpYa211ice1lprfeJhrbXWJ+wP1lprvfaw1lrrEw9rrbU+8bDWWusTD2uttT7xsNZa6xMPa621PvHw/8MZcd0AAAAuSURBVNqDYxoAAAAEQM7+oS3hCQBw0QBw0QBw0QBw0QBw0QBw0QBw0QBw0QBwMdVY/lOueXlWAAAAAElFTkSuQmCC",
      "sessionId": "KODgCta87Utwb3LqjBDHXX"
    }
  }
}

Using any base64 string to image decoder, you can output the QR image generated above. Scanning the QR with your wallet you will receive a transaction. Signing it will automatically connect your wallet to the ORB platform.

Once you receive your response from the CreateWalletSyncQRCodeSession mutation, keep the sessionId noted somewhere, as you will need it in the next steps.

Connecting to the ORB Platform

Retrieving an Active session

An active sessionId can always be retrieved. This is the sessionId with which the developer wallet connected to the ORB platform for the first time.

RetrieveActiveSession

query RetrieveActiveSession($address: String!) {
  RetrieveActiveSession(address: $address) {
    previousSessionId
  }
}

Input Variables

"address": "tz1Sd5ceMABaiPU4qQvvrVJQYbE6X2gJBmf8"

Response

{
  "data": {
    "RetrieveActiveSession": {
      "previousSessionId": "QqLb0obD7F3Tiu4JNdX0r"
    }
  }
}

Acquiring your Access Token

Once you have successfully connected your wallet to ORB, it is now time to retrieve your access token. This token enables you to fully interact with the API as well as the smart contracts. The access token allows you to create NFTs, projects or collections, send or burn tokens and more. Think of it as a verification token, it allows ORB to know that you are indeed a developer and you need full access to the API.

ORB's Access Token has a lifetime of 7 days. Once you generate an access token, it will be valid for that period, after which it will expire and you will no longer be able to use it. Once expired you can Refresh your Access Token in order to acquire a new one. There can only be only one valid active access token each time.

Use the following mutation to generate your Access Token

GetTokenForSession

mutation GetTokenForSession($address: String!, $sessionId: String!, $gameId:String!){
  GetTokenForSession(address: $address, sessionId: $sessionId, gameId: $gameId){
    accessToken
  }
}

Input Variables

"address": "tz1aWZmdKqKvGP331yWJjqgCZakGci3VAGmj",
"sessionId": "6u296Lbxbj8gBhylyiZPU",
"gameId" : "game:dGzLJYWJtkF8kdC4iVlb-"

Response

{
  "data": {
    "GetTokenForSession": {
      "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhZGRyZXNzIjoidHoxYVdabWRLcUt2R1AzMzF5V0pqcWdDWmFrR2NpM1ZBR21qIiwiZ2FtZUlkIjoiZ2FtZTpkR3pMSllXSnRrRjhrZEM0aVZsYi0iLCJzZXNzaW9uSWQiOiI2dTI5NkxieGJqOGdCaHlseWlaUFUiLCJpc3MiOjE2OTQwMDA0MjMsImV4cCI6MTY5NDA4NjgyMzY4MSwid2FsbGV0VHlwZSI6InBsYXllciIsImlhdCI6MTY5NDAwMDQyM30.grlHmc09c1MLEFZtsTJNuc7G7NZXLoNmhhDs-Hzzzmk"
    }
  }
}

Once you have your access token, you can add it to the Authorization headers, each time you call a mutation using the ORB3 API. If you do not include the access token in your calls, they will fail and you will not receive any transaction to sign in your wallet.

Access Token Operations

Once your access token loses its validity, and eventually expires, you will need to refresh it and acquire a new one in order to continue to have access to the ORB3 API.

The advanced version of the UnityORB SDK has a build in function which will automatically renew the developer's access token. You can learn more about the UnityORB SDK here.

Use the following mutation to refresh your Access Token.

RefreshTokenForSession

mutation RefreshTokenForSession($sessionId: String!, $address: String!) {
  RefreshTokenForSession(sessionId: $sessionId, address: $address) {
    accessToken
  }
}

Input Variables

"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhZGRyZXNzIjoidHoxYVdabWRLcUt2R1AzMzF5V0pqcWdDWmFrR2NpM1ZBR21qIiwiZ2FtZUlkIjoiZ2FtZTpkR3pMSllXSnRrRjhrZEM0aVZsYi0iLCJzZXNzaW9uSWQiOiI2dTI5NkxieGJqOGdCaHlseWlaUFUiLCJpc3MiOjE2OTQ1OTE5MDMsImV4cCI6MTY5NDY3ODMwMzA3MCwid2FsbGV0VHlwZSI6InBsYXllciIsImlhdCI6MTY5NDU5MTkwM30.QQL7Xvsnc-iRPUWVIKsaVCUAwrq_BEdIoZ6xqIt2XL4"

Response

{
  "data": {
    "RefreshTokenForSession": {
      "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXNzaW9uaWQiOiJRcUxiMG9iRDdGM1RpdTRKTmRYMHIiLCJhZGRyZXNzIjoidHoxU2Q1Y2VNQUJhaVBVNHFRdnZyVkpRWWJFNlgyZ0pCbWY4Iiwid2FsbGV0dHlwZSI6InBsYXllciIsImlzcyI6MTY5NjQ5MTk5MCwiZXhwIjoxNjk2NTc4MzkwMDk4LCJpYXQiOjE2OTY0OTE5OTB9.YhBKNZheSIPOdNceJjAbH3r7EXrgByXPj_00lIUmx4w"
    }
  }
}

In order to refresh your access token, you will need to provide your wallet address and the sessionId you were provided when first syncing to the platform. In case you do not have this at hand, you can always retrieve it via the RetrieveActiveSession Query. Once the mutation is called, a transaction will pop-up in the wallet, in order for the developer to sign a payload. This verifies that the developer is the party asking for the access token refresh.

Signing the payload to refresh the Access Token

Retrieving an Active Access Token

An active and still valid access token can always be retrieved, together with information such as its expiration date and issued date.

RetrieveAccessToken

query RetrieveAccessToken {
  retrieveAccessToken {
    AccessToken
    ExpiryDate
    IssuedDate
  }
}

Signing the payload to retrieve an active Access Token

In order retrieve an active access token, the developer will need to sign an incoming payload.

Now that we have everything set up, it's time to jump into the fun! Let's go ahead and create our first project in ORB.