index.html

</li>
      
        <li class="md-nav__item">
  <a href="#what-is-the-purpose-of-the-get_security_auth-function-in-the-invoker-client" class="md-nav__link">
    <span class="md-ellipsis">
      What is the purpose of the "get_security_auth" function in the invoker client?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#what-is-the-purpose-of-the-register_security_context-function-in-the-invoker-client" class="md-nav__link">
    <span class="md-ellipsis">
      What is the purpose of the "register_security_context" function in the invoker client?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#is-a-user-the-same-as-an-exposer" class="md-nav__link">
    <span class="md-ellipsis">
      Is a user the same as an exposer?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#where-can-i-put-my-endpoint" class="md-nav__link">
    <span class="md-ellipsis">
      Where can I put my endpoint?
    </span>
  </a>
  
</li>
      
    </ul>
  
</nav>
      
    </li>
  

    
  </ul>
</nav>
                  </div>
                </div>
              </div>
            
            
              
              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    

<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
  
    
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#does-the-user-have-to-develop-the-3-elements-of-the-provider-aef-amf-and-apf" class="md-nav__link">
    <span class="md-ellipsis">
      Does the user have to develop the 3 elements of the provider (AEF, AMF and APF)?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#there-is-one-party-that-publishes-the-api-and-another-that-exposes-it-what-is-the-difference" class="md-nav__link">
    <span class="md-ellipsis">
      There is one party that publishes the API and another that exposes it, what is the difference?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#before-publishing-an-api-do-you-have-to-be-registered-in-capif" class="md-nav__link">
    <span class="md-ellipsis">
      Before publishing an API, do you have to be registered in CAPIF?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#where-is-the-registration-done" class="md-nav__link">
    <span class="md-ellipsis">
      Where is the registration done?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#is-the-username-and-password-chosen-by-the-user-when-registering-or-is-it-assigned-when-requesting-registration-to-capif-public-instance" class="md-nav__link">
    <span class="md-ellipsis">
      Is the username and password chosen by the user when registering or is it assigned when requesting registration to CAPIF public instance?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#what-is-a-csr" class="md-nav__link">
    <span class="md-ellipsis">
      What is a CSR?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#when-doing-the-register_provider-where-can-i-find-the-csrs-that-are-generated" class="md-nav__link">
    <span class="md-ellipsis">
      When doing the register_provider where can I find the CSRs that are generated?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#how-to-use-the-example-client-capif_invoker_gui" class="md-nav__link">
    <span class="md-ellipsis">
      How to use the example client (CAPIF_INVOKER_GUI)?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#where-is-the-capif-public-instance-located" class="md-nav__link">
    <span class="md-ellipsis">
      Where is the CAPIF public instance located?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#do-you-have-to-publish-3-apis-one-for-each-instance" class="md-nav__link">
    <span class="md-ellipsis">
      Do you have to publish 3 APIs? one for each instance?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#once-the-api-is-published-is-it-always-active-or-do-you-have-to-republish-it-every-time-you-want-to-use-it" class="md-nav__link">
    <span class="md-ellipsis">
      Once the API is published, is it always active? Or do you have to republish it every time you want to use it?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#would-the-same-username-and-password-be-valid-for-different-invokers" class="md-nav__link">
    <span class="md-ellipsis">
      Would the same username and password be valid for different invokers?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#what-is-the-notfication-destination-field-in-the-register_invoker-request" class="md-nav__link">
    <span class="md-ellipsis">
      What is the notfication destination field in the register_invoker request?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#is-the-notification_destination-a-required-field-in-the-register_invoker" class="md-nav__link">
    <span class="md-ellipsis">
      Is the notification_destination a required field in the register_invoker
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#what-is-the-purpose-of-the-discover_service-function-in-the-invoker-client" class="md-nav__link">
    <span class="md-ellipsis">
      What is the purpose of the "discover_service" function in the invoker client?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#what-is-the-purpose-of-the-get_security_auth-function-in-the-invoker-client" class="md-nav__link">
    <span class="md-ellipsis">
      What is the purpose of the "get_security_auth" function in the invoker client?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#what-is-the-purpose-of-the-register_security_context-function-in-the-invoker-client" class="md-nav__link">
    <span class="md-ellipsis">
      What is the purpose of the "register_security_context" function in the invoker client?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#is-a-user-the-same-as-an-exposer" class="md-nav__link">
    <span class="md-ellipsis">
      Is a user the same as an exposer?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#where-can-i-put-my-endpoint" class="md-nav__link">
    <span class="md-ellipsis">
      Where can I put my endpoint?
    </span>
  </a>
  
</li>
      
    </ul>
  
</nav>
                  </div>
                </div>
              </div>
            
          
          
            <div class="md-content" data-md-component="content">
              <article class="md-content__inner md-typeset">
                
                  



<h1 id="frequently-asked-questions-faq">Frequently Asked Questions (FAQ)</h1>
<h3 id="does-the-user-have-to-develop-the-3-elements-of-the-provider-aef-amf-and-apf">Does the user have to develop the 3 elements of the provider (AEF, AMF and APF)?</h3>
<p>No, you only have to make the request to the "/onboarding" endpoint. In it you must specify a CSR for the AEF, APF and AMF and you will receive the certificates for each of them in the response.</p>
<h3 id="there-is-one-party-that-publishes-the-api-and-another-that-exposes-it-what-is-the-difference">There is one party that publishes the API and another that exposes it, what is the difference?</h3>
<p>There are different services, the APF, intended for publishing the APIs, and the AEF, intended so that the invoker can call it. The APF is what connects to the Capif Core Function to publish the service and when the service is up, you need the AEF service so that invokers can connect to it.</p>
<h3 id="before-publishing-an-api-do-you-have-to-be-registered-in-capif">Before publishing an API, do you have to be registered in CAPIF?</h3>
<p>Yes, before publishing an API you must register using the POST /register endpoint.</p>
<h3 id="where-is-the-registration-done">Where is the registration done?</h3>
<p>Registration is done in a REST API outside of the CAPIF specification taht we have implemented.</p>
<h3 id="is-the-username-and-password-chosen-by-the-user-when-registering-or-is-it-assigned-when-requesting-registration-to-capif-public-instance">Is the username and password chosen by the user when registering or is it assigned when requesting registration to CAPIF public instance?</h3>
<p>When you make the request to the "/endpoint" of register, you will be returned a username and a password determined by CAPIF.</p>
<h3 id="what-is-a-csr">What is a CSR?</h3>
<p>A CSR is a Certificate Signing Request. It is a generated data block where the certificate is planned to be installed and contains key information such as public key, organization, and location, and is used to request a certificate from a certificate authority (CA). In CAPIF, 3 CSRs are necessary to register a provider, for AEF, APF and AMF.</p>
<h3 id="when-doing-the-register_provider-where-can-i-find-the-csrs-that-are-generated">When doing the register_provider where can I find the CSRs that are generated?</h3>
<p>When using the "register_provider" command, if you add the "debug" option, it shows you a json with the data used to register the provider. There we can find in the body a list of 3 elements corresponding to AEF, APF and AMF. IN each of them, the apiProbPubKey field corresponds to the CSR.</p>
<h3 id="how-to-use-the-example-client-capif_invoker_gui">How to use the example client (CAPIF_INVOKER_GUI)?</h3>
<p>First you have to make a "./run.sh host:port" indicating the address of the public CAPIF. Once the Docker containers are up, you have to do a "./terminal_to_py_netapp.sh" and then a "python main.py". At this point we will find ourselves in a console with some predefined commands to use the Client. If we press tab twice it will bring up the list of available commands.</p>
<h3 id="where-is-the-capif-public-instance-located">Where is the CAPIF public instance located?</h3>
<p>The CAPIF public instance can be found at the following URLs:
- capif.mobilesandbox.cloud:37211 (HTTPS)
- capif.mobilesandbox.cloud:37212 (HTTP)</p>
<h3 id="do-you-have-to-publish-3-apis-one-for-each-instance">Do you have to publish 3 APIs? one for each instance?</h3>
<p>No, you only have to publish a single API but each component is responsible for a specific service, whether publishing or exposing.</p>
<h3 id="once-the-api-is-published-is-it-always-active-or-do-you-have-to-republish-it-every-time-you-want-to-use-it">Once the API is published, is it always active? Or do you have to republish it every time you want to use it?</h3>
<p>It is better to unsubscribe the API every time you exit the application since otherwise it could be republished and it would be double.</p>
<h3 id="would-the-same-username-and-password-be-valid-for-different-invokers">Would the same username and password be valid for different invokers?</h3>
<p>Yes, a user can have multiple invokers at the same time, and as such, the username and password would be the same.</p>
<h3 id="what-is-the-notfication-destination-field-in-the-register_invoker-request">What is the notfication destination field in the register_invoker request?</h3>
<p>This is the callback URL used to notify events. CAPIF has an Event service to subscribe to that notifies actions such as a subscription to an API, a change in the state of an API...</p>
<h3 id="is-the-notification_destination-a-required-field-in-the-register_invoker">Is the notification_destination a required field in the register_invoker</h3>
<p>No, it is not mandatory, but if you do not enter it you will not receive any CAPIF events. For example, the APF may delete the API, you will not be notified that the API is no longer available.</p>
<h3 id="what-is-the-purpose-of-the-discover_service-function-in-the-invoker-client">What is the purpose of the "discover_service" function in the invoker client?</h3>
<p>The discover_service returns a json with all the services that exist exposed in CAPIF at that moment.</p>
<h3 id="what-is-the-purpose-of-the-get_security_auth-function-in-the-invoker-client">What is the purpose of the "get_security_auth" function in the invoker client?</h3>
<p>Sirve para pedir el token o para refrescarlo en caso de que haya caducado. You have to use that token to call the API from the invoker.</p>
<h3 id="what-is-the-purpose-of-the-register_security_context-function-in-the-invoker-client">What is the purpose of the "register_security_context" function in the invoker client?</h3>
<p>To consume the API it is necessary to have a Security Context registered with the data and the authentication method.</p>
<h3 id="is-a-user-the-same-as-an-exposer">Is a user the same as an exposer?</h3>
<p>No, a user registers in CAPIF and once done can have the role of invoker, provider or both.</p>
<h3 id="where-can-i-put-my-endpoint">Where can I put my endpoint?</h3>
<p>You have to set your endpoint when doing the "publish_service" functionality:<br />
<code>publish_service capif_ops/config_files/service_api_description_hello.json</code></p>
<p>In the file "service_api_description_hello.json" you configure the service that is going to be exposed and by developing one to suit you, you expose your API.</p>












                
              </article>
            </div>
          
          
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
        </div>
        
          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
  Back to top
</button>
        
      </main>
      
        <footer class="md-footer">
  
    
      
      <nav class="md-footer__inner md-grid" aria-label="Footer" >
        
          
          <a href="../contribute/documenting/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Documenting">
            <div class="md-footer__button md-icon">
              
              <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
            </div>
            <div class="md-footer__title">
              <span class="md-footer__direction">
                Previous
              </span>
              <div class="md-ellipsis">
                Documenting
              </div>
            </div>
          </a>
        
        
      </nav>
    
  
  <div class="md-footer-meta md-typeset">
    <div class="md-footer-meta__inner md-grid">
      <div class="md-copyright">
  
    <div class="md-copyright__highlight">
      Copyright &copy; 2019-2024 OpenCAPIF Project
    </div>
  
  
    Made with
    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
      Material for MkDocs
    </a>
  
</div>
      
        <div class="md-social">
  
    
    
    
    
      
      
    
    <a href="https://ocf.etsi.org/" target="_blank" rel="noopener" title="ocf.etsi.org" class="md-social__link">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M352 256c0 22.2-1.2 43.6-3.3 64H163.4c-2.2-20.4-3.3-41.8-3.3-64s1.2-43.6 3.3-64h185.3c2.2 20.4 3.3 41.8 3.3 64m28.8-64h123.1c5.3 20.5 8.1 41.9 8.1 64s-2.8 43.5-8.1 64H380.8c2.1-20.6 3.2-42 3.2-64s-1.1-43.4-3.2-64m112.6-32H376.7c-10-63.9-29.8-117.4-55.3-151.6 78.3 20.7 142 77.5 171.9 151.6zm-149.1 0H167.7c6.1-36.4 15.5-68.6 27-94.7 10.5-23.6 22.2-40.7 33.5-51.5C239.4 3.2 248.7 0 256 0s16.6 3.2 27.8 13.8c11.3 10.8 23 27.9 33.5 51.5 11.6 26 20.9 58.2 27 94.7m-209 0H18.6c30-74.1 93.6-130.9 172-151.6-25.5 34.2-45.3 87.7-55.3 151.6M8.1 192h123.1c-2.1 20.6-3.2 42-3.2 64s1.1 43.4 3.2 64H8.1C2.8 299.5 0 278.1 0 256s2.8-43.5 8.1-64m186.6 254.6c-11.6-26-20.9-58.2-27-94.6h176.6c-6.1 36.4-15.5 68.6-27 94.6-10.5 23.6-22.2 40.7-33.5 51.5-11.2 10.7-20.5 13.9-27.8 13.9s-16.6-3.2-27.8-13.8c-11.3-10.8-23-27.9-33.5-51.5zM135.3 352c10 63.9 29.8 117.4 55.3 151.6-78.4-20.7-142-77.5-172-151.6zm358.1 0c-30 74.1-93.6 130.9-171.9 151.6 25.5-34.2 45.2-87.7 55.3-151.6h116.7z"/></svg>
    </a>
  
    
    
    
    
      
      
    
    <a href="https://labs.etsi.org/rep/ocf" target="_blank" rel="noopener" title="labs.etsi.org" class="md-social__link">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="m503.5 204.6-.7-1.8-69.7-181.78c-1.4-3.57-3.9-6.59-7.2-8.64-2.4-1.55-5.1-2.515-8-2.81s-5.7.083-8.4 1.11c-2.7 1.02-5.1 2.66-7.1 4.78-1.9 2.12-3.3 4.67-4.1 7.44l-47 144H160.8l-47.1-144c-.8-2.77-2.2-5.31-4.1-7.43-2-2.12-4.4-3.75-7.1-4.77a18.1 18.1 0 0 0-8.38-1.113 18.4 18.4 0 0 0-8.04 2.793 18.1 18.1 0 0 0-7.16 8.64L9.267 202.8l-.724 1.8a129.57 129.57 0 0 0-3.52 82c7.747 26.9 24.047 50.7 46.447 67.6l.27.2.59.4 105.97 79.5 52.6 39.7 32 24.2c3.7 1.9 8.3 4.3 13 4.3s9.3-2.4 13-4.3l32-24.2 52.6-39.7 106.7-79.9.3-.3c22.4-16.9 38.7-40.6 45.6-67.5 8.6-27 7.4-55.8-2.6-82"/></svg>
    </a>
  
    
    
    
    
      
      
    
    <a href="https://www.linkedin.com/company/opencapif/" target="_blank" rel="noopener" title="www.linkedin.com" class="md-social__link">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3M135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5m282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9z"/></svg>
    </a>
  
    
    
    
    
      
      
    
    <a href="https://twitter.com/OpenCAPIF" target="_blank" rel="noopener" title="twitter.com" class="md-social__link">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M389.2 48h70.6L305.6 224.2 487 464H345L233.7 318.6 106.5 464H35.8l164.9-188.5L26.8 48h145.6l100.5 132.9zm-24.8 373.8h39.1L151.1 88h-42z"/></svg>
    </a>
  
</div>
      
    </div>
  </div>
</footer>
      
    </div>
    <div class="md-dialog" data-md-component="dialog">
      <div class="md-dialog__inner md-typeset"></div>
    </div>
    
      <div class="md-progress" data-md-component="progress" role="progressbar"></div>
    
    
    <script id="__config" type="application/json">{"base": "..", "features": ["navigation.instant", "navigation.instant.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight"], "search": "../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
    
    
      <script src="../assets/javascripts/bundle.c8b220af.min.js"></script>
      
    
  </body>
</html>