sc_call_api($profile, $arr_settings)

Esta macro possibilita a utilização das APIs integradas ao Scriptcase nos eventos das aplicações.

Ela pode ser utilizada com um Perfil de API criado na interface ou informando as credenciais da API no evento.

Confira abaixo os parâmetros da macro:

 

Detalhe dos Parâmetros

Parâmetros Sintaxe Descrição
profile

O nome do botão do perfil pode ser informado utilizando aspas duplas, aspas simples ou variável.

Exemplo: Utilização da macro com um nome de perfil.

sc_call_api('nome_do_perfil');

Exemplo: Utilização da macro com o valor vazio

// Neste caso o parâmetro $array_settings torna-se obrigatório.
sc_call_api("", $array_settings);

Este parâmetro é obrigatório.

Ele recebe o nome do perfil configurado no menu "ferramentas > API"

É possível também passar o valor vazio, neste caso, o parâmetro $array_settings torna-se obrigatório.
settings

Este parâmetro recebe um array com as credenciais da API utilizada, caso o parâmetro profile esteja vazio.

Exemplo: Utilização da macro com o parâmetro settings

$arr_settings = array( 'settings' => ['gateway' => 'mandrill', 'api_key'=> {api_key}] );
sc_call_api("", $arr_settings);

Este parâmetro é opcional, e deve ser utilizado apenas se o parâmetro profile receber um valor vazio.

Neste caso o parâmetro settings torna-se obrigatório já que contém os dados de acesso e credenciais da API utilizada.

 

APIs

Esta macro pode ser utilizada com todas as APIs disponíveis no Scriptcase.

Confira abaixo a lista de APIs disponíveis.

Categorias Gateways
Email SMTP Mandrill Amazon SES    
SMS Twilio Plivo Clickatell    
Pagamento Paypal Pagseguro MercadPago Braintree Stripe
WhatsApp Chatapi        
Armazenamento Google Drive Dropbox Amazon S3    
Autenticação Google Authenticador        
Relatórios Google Sheets        

 

Exemplos

Confira abaixo alguns exemplos de utilização da macro com o parâmetro settings. 

Exemplo de utilização básica da macro com o Mandrill

$settings = array( 'settings' => ['gateway' => 'mandrill', 'api_key'=> {api_key}]);
$mandrill = sc_call_api('', $settings);

 

Exemplo 2 - Envio de e-mail utilizando o mandrill.

$txt_no_tags = strip_tags({msg});

$arr_merge = array(
                 'name'  => '',
                 'type'  => 'to',
                 'email' => 'exemplo@exemplo.com'
             );

$var_config = array( 'settings' => ['gateway' => 'mandrill', 'api_key'=> {api_key}] );

$mandrill = sc_call_api('', $var_config);
$var_msg = array(
               'from_email'                     => {from_email},
               'from_name'                      => {from_name},
                'html'                          => {msg},
                'text'                          => $txt_no_tags,
                'to'                            => array($arr_merge),              
                'subject'                       => {subject},
                'important'                     => true,            
                'auto_text'                     => null,
                'auto_html'                     => null,
                'inline_css'                    => null,
                'metadata'                      => array('website' => 'www.scriptcase.net')
    );

$async = false;
$retorno = $mandrill->messages->send($var_msg, $async);

Exemplo 3 - Enviando SMS utilizando clickatell.

$var_config     = array( 
  'message'     => [
    'to'      => {sms_to},
    'message'     => {sms_txt},
    ],
    'settings'    => [
    'gateway'   => {gateway},
    'auth_token'  => {auth_token},
    ] 
);

sc_send_sms($var_config);

Exemplo 4 - Usando a macro com PagSeguro

  $arr_settings = [
            'gateway' => 'pagseguro',
            'environment' => 'sandbox',
            'auth_email' => 'exemplo@gmail.com',
            'auth_token' => '72AE21503DDA4840BE1DC7945F6D1CE1'
                 ];
sc_call_api('',$arr_settings);

Exemplo 5 - Usando a macro com PayPal

  $arr_settings = [
            'gateway' => 'paypal',
            'environment' => 'sandbox',
            'auth_email' => 'exemplo@gmail.com',
            'auth_token' => '72AE21503DDA4840BE1DC7945F6D1CE1'
                 ];
sc_call_api('',$arr_settings);