1"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[6919],{3905:function(e,n,t){t.d(n,{Zo:function(){return u},kt:function(){return m}});var r=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{};n%2?i(Object(t),!0).forEach((function(n){a(e,n,t[n])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):i(Object(t)).forEach((function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(t,n))}))}return e}function l(e,n){if(null==e)return{};var t,r,a=function(e,n){if(null==e)return{};var t,r,a={},i=Object.keys(e);for(r=0;r<i.length;r++)t=i[r],n.indexOf(t)>=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)t=i[r],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=r.createContext({}),c=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},u=function(e){var n=c(e.components);return r.createElement(s.Provider,{value:n},e.children)},p={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),d=c(t),m=a,f=d["".concat(s,".").concat(m)]||d[m]||p[m]||i;return t?r.createElement(f,o(o({ref:n},u),{},{components:t})):r.createElement(f,o({ref:n},u))}));function m(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,o=new Array(i);o[0]=d;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l.mdxType="string"==typeof e?e:a,o[1]=l;for(var c=2;c<i;c++)o[c]=t[c];return r.createElement.apply(null,o)}return r.createElement.apply(null,t)}d.displayName="MDXCreateElement"},7274:function(e,n,t){t.r(n),t.d(n,{assets:function(){return u},contentTitle:function(){return s},default:function(){return m},frontMatter:function(){return l},metadata:function(){return c},toc:function(){return p}});var r=t(7462),a=t(3366),i=(t(7294),t(3905)),o=["components"],l={id:"php-sdk",title:"PHP SDK Guide",sidebar_label:"PHP SDK"},s=void 0,c={unversionedId:"php-sdk",id:"php-sdk",title:"PHP SDK Guide",description:"Installation",source:"@site/docs/php-sdk.md",sourceDirName:".",slug:"/php-sdk",permalink:"/docs/php-sdk",draft:!1,editUrl:"https://github.com/facebook/docusaurus/edit/master/website/docs/php-sdk.md",tags:[],version:"current",lastUpdatedBy:"Privy",lastUpdatedAt:1780863317,formattedLastUpdatedAt:"Jun 7, 2026",frontMatter:{id:"php-sdk",title:"PHP SDK Guide",sidebar_label:"PHP SDK"},sidebar:"mySidebar",previous:{title:"Index",permalink:"/docs/sdk/"},next:{title:"Node.JS SDK",permalink:"/docs/node"}},u={},p=[{value:"Installation",id:"installation",level:2},{value:"Usage",id:"usage",level:2},{value:"Initialization",id:"initialization",level:3},{value:"Check Domain Availability",id:"check-domain-availability",level:3},{value:"Registering a New Domain",id:"registering-a-new-domain",level:3},{value:"Get Domains",id:"get-domains",level:3}],d={toc:p};function m(e){var n=e.components,t=(0,a.Z)(e,o);return(0,i.kt)("wrapper",(0,r.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"installation"},"Installation"),(0,i.kt)("p",null,"This SDK can be installed via composer."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-console"},"$ composer require privyreza/rm-php-sdk\n")),(0,i.kt)("h2",{id:"usage"},"Usage"),(0,i.kt)("blockquote",null,(0,i.kt)("p",{parentName:"blockquote"},"Make sure you already got you developer token. If you dont have the token refer to this guide: - and that its set properly using this guide: -")),(0,i.kt)("h3",{id:"initialization"},"Initialization"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"require \"vendor/autoload.php\";\n\n// Load the Client\nuse Resellme\\Client;\n\n// Get token from env\n$token = getenv('RM_TOKEN');\n\n// Initialize the Client\n$client = new Client($token);\n\n// For testing / sandbox:\n// $client = new Client($token, 'https://test.api.resellme.co.zw');\n")),(0,i.kt)("h3",{id:"check-domain-availability"},"Check Domain Availability"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"$domain = 'resellme-testdomain.co.zw';\n\n/*\n * Check availability\n * @return array - with domain status\n *\n */\n$domainSearch = $client->searchDomain($domain);\n")),(0,i.kt)("h3",{id:"registering-a-new-domain"},"Registering a New Domain"),(0,i.kt)("blockquote",null,(0,i.kt)("p",{parentName:"blockquote"},"Make sure you are testing on the sandbox platform.")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},'/**\n * Domain Details\n *\n */\n// Domain Owner\n$contact = [\n "contacts" => [\n "registrant" => [\n "first_name" => "SDK Privy",\n "last_name" =>"SDK Reza",\n "email" =>"[email protected]",\n "company" =>"SDK Company",\n "mobile" =>"0773234827",\n "street_address" =>"78 Test Street",\n "core_business" =>"SDK Test Core Business",\n "city" =>"Nairobi",\n "country" =>"Kenya"\n ]\n ]\n];\n\n// Nameservers\n$nameservers = [\n "ns1" => "ns1.cloud-dns.com",\n "ns2" => "ns2.cloud-dns.com"\n];\n\n// Prepare the data\n$data = [\n \'domain\' => $domain,\n \'nameservers\' => $nameservers,\n \'contacts\' => $contacts\n]; \n\n/**\n * Register the domain now\n * @return array\n *\n */\n$domain = $client->registerDomain($data);\n\n')),(0,i.kt)("h3",{id:"get-domains"},"Get Domains"),(0,i.kt)("p",null,"You can use this to fetch all your domains. You can pass filters if you want a filtered result."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"$filters = [\n 'status' =>
1 'registered', // Get Registered only domains\n 'name' => 'resellme-testdomain.co.zw' // Get By Domain name\n];\n\n$domains = $client->getDomains($filters);\n")))}m.isMDXComponent=!0}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.